This is a readymade api with authentication implemented. This api is built using Django Rest framework and simple JWT. I made it for my personal use for future projects. Feel free to use it.
Hope you find things easy to understand here. If you have any doubts, feel free to contact me.
- Install python 3.10.12(other versions(>3) should work as well. 3.10.12 is the current version at the time of developing this.) and pip on your system.
- Clone the repository into a directory. (Or fork your own copy and clone it, if you want to contribute.)
- 'cd' into the directory where 'manage.py' is in.
- Create a virtual environment in this directory and activate it.
- Install the requirements using the command:
pip install -r requirements.txt - Run the server using the command:
python manage.py runserver
- Open the server in your browser, using the url in your terminal(where the server is running). Or directly go to the url 'http://127.0.0.1:8000/'.
- Add 'admin/' at the end of the url. Or visit 'http://127.0.0.1:8000/admin/'.
email: 'tef@gmail.com'
Disclaimer 1: This authentication system uses email instead of username(which is the default one in django). So, you'll have to use the email to login and register, as email seems to be a more standard way of authentication.
Disclaimer 2: Make sure to migrate the database before running the server. Use the following commands.
python manage.py makemigrations
python manage.py migrate
If you're running the server locally, in localhost port 8000, go to this api documentation for a detailed documentation of the api endpoints. (Make sure the server is running, as this api documentation is not live, yet.)