The application is a generic backend service built using Django Rest Framework (DRF) that provides authentication and post services.The authentication services handle user registration, login, and user management, including the ability to create super-users with additional privileges. The users are authenticated through a secure token based mechanism.The post services in the application enable users to perform CRUD operations on posts. Users can create new posts, retrieve existing posts, update post details, and delete posts when necessary. These services provide a flexible and scalable way to manage and interact with posts within the application.This application also leverages google drive storage as a cloud database service alongside the default database. The code also includes a custom email otp server which can be used to verify any email.
Overall, this application provides a solid foundation for building various types of backend services, with a focus on user authentication and post management, leveraging Django Rest Framework , nodeJS and Google's service account for cloud storage functionality.
To integrate the google drive storage functionality with DRF , follow this blog : Django-GDrive
Create the database :
python manage.py makemigreations
python manage.py migrate
Run the django server :
python .\manage.py runserver
Here are the API endpoints from our backend service :
-
Use :
To register a user
Format :POST Request{ "name": "Subham", "email": "[email protected]", "password": "***" } -
Use :
To register a super-user
Format :POST Request{ "name": "Subham-admin", "email": "[email protected]", "password": "***" } -
Use :
To login , Obtain the token from response for future usage
Format :POST Request{ "email": "[email protected]", "password": "***" } -
Use :
To register a user
Format :POST Request{ "email": "[email protected]", "password": "newpassword" } -
Use :
To register a user
Format :POST Request{ "email": "[email protected]", } -
Use :
To get all users info
Format :GET Request -
Use :
To get user info
Format :GET Request -
Use :
To register a user
Format :POST Request (Name and profile pic)Format for token in Header : Authorization: "Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6IjIwMjBjc2IxMzE3QGlpdHJwci5hYy5pbiIsImV4cCI6MTY4MDgyMDgwNH0.wgsupH5q67u5qjo_pHSe71OHolP2S2iEjUwjEVSFgSk"
-
Use :
To view and add posts
Permission :
GET - Everyone
POST - After authenticationFormat for token in Header : Authorization: "Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6IjIwMjBjc2IxMzE3QGlpdHJwci5hYy5pbiIsImV4cCI6MTY4MDgyMDgwNH0.wgsupH5q67u5qjo_pHSe71OHolP2S2iEjUwjEVSFgSk" -
Use :
To delete post by id
Permission :
GET - After authenticationFormat for token in Header : Authorization: "Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6IjIwMjBjc2IxMzE3QGlpdHJwci5hYy5pbiIsImV4cCI6MTY4MDgyMDgwNH0.wgsupH5q67u5qjo_pHSe71OHolP2S2iEjUwjEVSFgSk" -
Use :
To get all posts by chapter name
Permission :All can get it (GET request) -
Use :
To get post by id
Permission :
GET - Everyone
POST,PUT - Teacher after logging in through tokenFormat for token in Header : Authorization: "Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6IjIwMjBjc2IxMzE3QGlpdHJwci5hYy5pbiIsImV4cCI6MTY4MDgyMDgwNH0.wgsupH5q67u5qjo_pHSe71OHolP2S2iEjUwjEVSFgSk" -
Use :
To get likes , dislikes, liked_users, disliked_users, post by id
Permission :
GET - Everyone
PUT - Everyone
Run the nodeJS server :
node index.js
Here are the API endpoints from our email-otp verification service :
-
Use :
To send email containing otp to user
Format :GET Request{ /[email protected]&otp=792301 } -
Use :
To verify otp given by user
Format :GET{ /[email protected]&otp=792301 }
-
Choose a server or hosting provider that supports Python and Django. Some popular options include:
-
Follow the provider's instructions to set up a new server or application instance. Make sure to configure it with the necessary Python version and dependencies.
-
If using a cloud provider, set up any required environment variables or configuration settings. These may include database credentials, secret keys, or any other custom settings specific to your application.
-
Make sure to expose necessary ports (8000 and 3000) on the server. You can follow this blog to do so.
-
Make sure your application is production-ready by performing the following steps:
- Set
DEBUG = Falsein your Django settings. - Configure your application to use a production database (e.g., PostgreSQL).
- Update any sensitive information such as secret keys or database credentials to use environment variables.
- Run thorough testing to ensure your application functions as expected.
- Set
-
Create a requirements file (
requirements.txt) that lists all the Python packages required by your application. Use the commandpip freeze > requirements.txtto generate this file.
-
Connect to your server using SSH or the provider's provided method.
-
Clone your Django Rest Framework project repository to your server machine using Git:
git clone <repository-url>. -
Create a virtual environment and install the required Python packages using the command
pip install -r requirements.txt. -
Run the Django database migrations:
python manage.py migrate. -
If applicable, load initial data or create a superuser account using Django management commands.
-
Run
npm icommand inside the email-otp directory to set up the node modules.
-
Follow this blog for detailed steps : Django-deployment
-
For nodeJS server deployment , use pm2.
Command :pm2 start index..jsinside the email-otp folder.