Skip to content

A simple CLI and server to check a name availability on Twitter and GitHub.

License

Notifications You must be signed in to change notification settings

davidaparicio/namecheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Namecheck

Namecheck logo

GoDoc Go Report Card codecov build Github GitLab Froggit

Security Rating Vulnerabilities License FOSSA Status Maintenance Twitter

Overview

A simple CLI and server to check a name availability on Twitter and GitHub.

Namecheck diagram

Source: https://gitdiagram.com/davidaparicio/namecheck

How to use it

If you have already Docker installed on your laptop

docker run davidaparicio/namecheck:<TAG/VERSION_LIKE_v0.0.5> <PSEUDO_TO_CHECK>

If not, you need Go and all dependencies

go run cmd/cli/main.go <PSEUDO_TO_CHECK>

or the server with

go run cmd/server/main.go

and check with a curl command curl http://localhost:8080/check?username=<PSEUDO_TO_CHECK>

For more information, you can see examples here

Remarks

Twitter checker is using a GCP Cloud Function, adding a network latency simulation, configurable through a parameter.

Server handles timeouts as recommended Filippo Valsorda on the Cloudflare blog (post 1 / post 2) and Ilija Eftimov.

ADR (Architecture decision record) about the usage of gorilla/mux can be found here.

Contribute

Works on my machine - and yours ! Spin up pre-configured, standardized dev environments of this repository, by clicking on the button below.

Open in Gitpod

Code coverage

coverage

Original project

Fork of the opensource project by @jub0bs, available on GitHub at https://github.com/jub0bs/namecheck.

License

Licensed under the MIT License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License here.

If needed some help, there are a "Licenses 101" by FOSSA, a Snyk explanation of MIT license and a French conference talk by Jean-Michael Legait about licenses.

FOSSA Status

About

A simple CLI and server to check a name availability on Twitter and GitHub.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 3

  •  
  •  
  •