https://github.com/manu-chroma/username-availability-checker
Live at : https://username-check.herokuapp.com/
https://github.com/manu-chroma/username-availability-checker
flask-api flask-application username-checker
Last synced: 2 months ago
JSON representation
Live at : https://username-check.herokuapp.com/
- Host: GitHub
- URL: https://github.com/manu-chroma/username-availability-checker
- Owner: manu-chroma
- Created: 2015-12-27T19:48:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-05-06T19:13:17.000Z (about 4 years ago)
- Last Synced: 2024-08-01T20:48:16.826Z (11 months ago)
- Topics: flask-api, flask-application, username-checker
- Language: Python
- Homepage:
- Size: 2.98 MB
- Stars: 95
- Watchers: 5
- Forks: 37
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Username Availability Checker
[](https://gitter.im/username-availability-checker/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
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:
``` bash
cp .env.copy .env
```
- Windows:
``` cmd
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
``` bash
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//``/``
- 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
```