README.md

Surgin - DRF

Table of Contents

• Description
• Getting Started
• Dependencies
• Installation
• Executing program
• Help
• Version History
• License
• Acknowledgments

Description

A powerful web-based music streaming platform featuring OpenAPI documentation and developed using DRF and JWT authentication

Getting Started

Dependencies

• Python 3.9+
• Docker (coming soon...)
• Git

Installing

1. Clone the repository:

   git clone https://github.com/2yt-code/Surgin.git
   cd Surgin

2. Create a Virtual Environment:

   python -m venv venv
   # On Windows:
   venv\Scripts\activate
   # On Linux:
   source venv/bin/activate

3. Install dependencies:

   pip install -r requirements/development.txt

Executing program

1. Basic commands for creating a database:

   python manage.py makemigrations
   python manage.py migrate

2. Run Server asgi:

   daphne config.asgi:application

For more information, visit the Daphne GitHub repository

Help

To read the project documentation, go to the docs folder or start the server and visit the schema/swagger-ui address

Version History

• 0.1
  • Initial Release

License

Released under the MIT license, See the LICENSE file