shusheng3927 / username-availability-checker

Live at : https://username-check.herokuapp.com/

Username Availability Checker

Check if a username can or cannot be taken on a bunch of popular social websites (such as Twitter, Instagram, Soundcloud, Github etc.)

Try it out at: https://username-check.herokuapp.com/

Setup

In case you want to try out project locally/contribute

Install dependencies

Creating a virtual environment for the project is recommended.

pip install -r requirements.txt
pip install -r test-requirements.txt

Setup config file

Copy and rename .env.copy to .env by:

• Unix or Linux:

cp .env.copy .env

• Windows:

copy .env.copy .env

You can choose to edit the default config before running the project

Running the web app

python username_api.py &
python frontend.py

To use, go to address generated by flask app in a browser.

Running tests for flask backend

Tested on python 3.4, 3.5 and 3.6

python -m pytest -s -v
coala --non-interactive -V

Running cli script

We don't test it often, so maybe it might be broken

python cli.py

Backend API endpoint

This endpoint is responsible for returning the username status to the frontend

• https://username-availability.herokuapp.com/check//<username>/
• eg: https://username-availability.herokuapp.com/check/facebook/yolo

Contributors

Since the inception of the project, it has on and off been in developement. It has seen minor contributions during hacktoberfest and major contributions from students during Google Codein 2017.

For the time being, the project is being maintained actively.

License

© MIT