Project Management System

A robust Django-based project management system that allows efficient management of projects, tasks, and team collaboration.

Guidelines

Option 1: Setting up this project & automatic deployment of this project in amazon ec2 instance

For automated deployment of this project on an Amazon EC2 instance, you can follow the deployment script and instructions available at: Django Server Deployment Scripts

Option 2: Setting Up The Project in Local Server

1. Clone the Repository

git clone https://github.com/centaurusgod/django_rest_project_management_api.git
cd django_rest_project_management_api
cd project_management_system

2. Set Up Virtual Environment

# On Linux(debian based)
sudo apt install virtualenv
virtualenv venv
source venv/bin/activate
# OR
python -m venv venv
source venv/bin/activate  # On Linux/Mac
# OR
venv\Scripts\activate  # On Windows

3. Install Dependencies

pip install -r requirements.txt

4. Database Setup

python manage.py makemigrations
python manage.py migrate

5. Populate Database with Dummy Data

python techforing_pms/populate_db.py

6. Create Superuser

python manage.py createsuperuser

Use the following credentials:

• Username: your_username
• Email: your_email@example.com
• Password: Password123!

7. Run Development Server

python manage.py runserver

API Documentation

Swagger Documentation Access

Access the Swagger API documentation at:

http://localhost:8000/api/docs/

Overview

Authentication Steps

Note: You need to login and get your access token to access the protected endpoints.

Public Endpoints (No Token Required):

• GET /api/users/login/
• POST /api/users/register/

Login Process

1. Access the login endpoint:

   http://localhost:8000/api/users/login/
   

2. Use these credentials:

   {
   "username": "user1",
   "password": "password123"
   }

   

Setting Up Authentication

1. Copy the access token from the response:

2. Authorize in Swagger UI:

3. Paste the access token:

Testing API Endpoints

After authentication, you can access all protected endpoints. For example: Reading all projects from Swagger API documentation:

Authentication

The system uses JWT (JSON Web Token) authentication. To access protected endpoints:

1. Obtain a token by logging in
2. Include the token in the Authorization header: Bearer <your-token>