Urban Dictionary REST API

Built With

(back to top)

Getting Started

Create a .env file in the api directory of the project. Fill the example below with your own values.

backlog=2048
debug=False
host="0.0.0.0"
log_level="trace"
port=8080
reload=True
timeout_keep_alive=5
workers=4

Install the Python dependencies:

pip3 install -r requirements.txt

Launch the server:

cd api
python3 api.py

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have any suggestion or petition that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Pablo González Rubio - @n0nuser_

Project Link: https://github.com/n0nuser/urban-dictionary-api

(back to top)