Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abbhiishek/codecommunitymusic-server
Backend service for Code Community Music
https://github.com/abbhiishek/codecommunitymusic-server
api backend django hacktoberfest postgresql python sql
Last synced: 4 days ago
JSON representation
Backend service for Code Community Music
- Host: GitHub
- URL: https://github.com/abbhiishek/codecommunitymusic-server
- Owner: Abbhiishek
- Created: 2023-06-20T04:31:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-02T07:38:38.000Z (over 1 year ago)
- Last Synced: 2024-11-21T02:13:26.210Z (2 months ago)
- Topics: api, backend, django, hacktoberfest, postgresql, python, sql
- Language: Python
- Homepage: https://codeforcommunity-backend.vercel.app
- Size: 2.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
## Code for Community Backend Service Readme
Welcome to the Code for Community Backend Service! This Django application serves as the backend for the Code for Community page, providing essential functionality and APIs. This README will guide you through the setup process, including creating a virtual environment, running necessary commands, and configuring an SMTP server for sending emails.
### Prerequisites
Before you begin, ensure you have the following installed on your system:
- Python 3.x
- pip (Python package manager)
- Docker
### Setup Instructions Using Docker
1. Clone the repository to your local machine.
```bash
git clone https://github.com/Abbhiishek/codecommunitymusic-server.git
```
2. Change into the project directory:
```bash
cd codecommunitymusic-server
```
3. Make Miragation for Database (POSTRESQL)
```BASH
docker compose -f docker-compose.yml run --rm backend python manage.py makemigrations
docker compose -f docker-compose.yml run --rm backend python manage.py migrate
```
3. Create a superUser for admin pannel at "http://localhost:8000/admin"
```bash
docker compose -f docker-compose.yml run --rm backend python manage.py createsuperuser
```
The prompt would ask for username , email and password for /admin page
3. Run the docker container:
```bash
docker compose -f docker-compose.yml up
```
5. Open the development server in your browser at "http://localhost:8000/"
### SMTP Configuration
This application uses SMTP to send emails, such as account verification and password reset emails. To configure SMTP, follow these steps:
1. Create a file named ".env" in the project root directory.
2. Add the following lines to the file, replacing the values with your own:
```bash
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=587
EMAIL_USE_TLS = True
EMAIL_HOST_USER =
EMAIL_HOST_PASSWORD =
```
>> Note: For security reasons, it's recommended to use environment variables to store sensitive information like email passwords.
3. Save the file and restart the development server.