Subscription Management

This is a full-stack web application for managing user subscriptions. It consists of a Django REST framework backend and a React frontend. This README provides a guide for setting up and running the project locally.

✨ Features

• User Authentication: Secure login and session management.

• Subscription Plans: Manage and view various subscription tiers.

• Subscription Lifecycle: Handle subscription creation, activation, and renewal.

• Payment Proof Upload: Users can upload proof of payment for manual verification.

• Admin Panel: A Django admin interface for administrators to manage users, plans, and verify payments.

Backend Setup

Table of Contents

• Backend Setup
• Prerequisites
• Setup Instructions
• API Endpoints
  • Authentication
  • User Management
  • Subscription Plans
  • User Subscriptions
• Testing
• Project Structure
• Dependencies
• Error Handling
• Development
• Frontend Setup
  • Setup Instructions

Prerequisites

• Python 3.11 or higher
• PostgreSQL
• pip (Python package manager)
• Node.js 14+ & npm

Setup Instructions

1. Clone the repository

   git clone https://github.com/PrajwalChaudhary25/subscription.git
   cd backend

2. Create a virtual environment

   # Windows
   python -m venv myenv
   myenv\Scripts\activate
   
   # Linux/MacOS
   python3 -m venv myenv
   source myenv/bin/activate

3. Install dependencies

   pip install -r requirements.txt

4. Database Setup

   • Install PostgreSQL if you haven't already
   • Create a new database named my_subscription_db
   • Update the database configuration in backend/settings.py if needed:

     DATABASES = {
             'default': {
                     'ENGINE': 'django.db.backends.postgresql',
                     'NAME': 'my_subscription_db',
                     'USER': 'admin',
                     'PASSWORD': 'password',
                     'HOST': 'localhost',
                     'PORT': '5432',
             }
     }

5. Apply migrations

   python manage.py migrate

6. Create a superuser

   python manage.py createsuperuser

7. Run the development server

   python manage.py runserver

The server will start at http://127.0.0.1:8000/

API Endpoints

Authentication

• POST /api/token/ - Obtain authentication token

User Management

• GET /api/user/ - Get current user details

Subscription Plans

• GET /api/plans/ - List all subscription plans
• GET /api/plans/<id>/ - Get specific plan details

User Subscriptions

• GET /api/users/<user_id>/subscriptions/ - Get user's subscriptions
• POST /api/purchase/ - Purchase a subscription plan
• POST /api/renew/ - Renew existing subscription

Testing

To run the tests:

python manage.py test

Project Structure

backend/
├── manage.py
├── backend/
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── media/
│   └── payment_proofs/      # Payment proof uploads
└── subscriptions/
        ├── __init__.py
        ├── admin.py            # Admin interface configuration
        ├── apps.py            # App configuration
        ├── models.py          # Database models
        ├── serializers.py     # API serializers
        ├── tests.py          # Unit tests
        ├── urls.py           # API routing
        ├── views.py          # API views
        ├── api/
        │   ├── serializers.py
        │   └── views.py
        └── migrations/       # Database migrations

Dependencies

• Django
• Django REST Framework
• django-cors-headers
• psycopg2-binary
• python-dateutil

Error Handling

The API uses standard HTTP response codes:

• 200: Success
• 400: Bad request
• 401: Unauthorized
• 404: Not found
• 500: Server error

Development

1. Make sure to activate your virtual environment before starting development
2. Use python manage.py makemigrations when modifying models
3. Apply migrations with python manage.py migrate
4. The development server will reload automatically when code changes

Frontend Setup

The frontend is a react application

Setup Instructions

1. Navigate to the forntend directory

cd ../frontend

2. Install Dependencies Use npm to install all the necessary packages defined in package.json.

npm install

3. Start the React Development Server

npm start

The frontend will be available at http://localhost:3000/.