ENGLISH
🎧 Welcome to Trackbase API!
This project was developed using the Django REST Framework (DRF) to create an API that manages artists, albums, genres, songs, and playlists. It’s perfect for practicing integrations with custom front-ends and exploring the world of APIs!
Follow the steps below to set up and run the project locally:
$ git clone <URL_OF_THIS_REPOSITORY>
$ cd trackbase-api
⚡ It is recommended to use a virtual environment to keep dependencies isolated.
$ python -m venv venv
$ venv\Scripts\activate
$ source venv/bin/activate
The required dependencies are listed in the requirements.txt file. Use the following command to install them:
$ pip install -r requirements.txt
Create the database tables by running the migrations:
$ python manage.py migrate
To access Django's admin interface, create a superuser:
$ python manage.py createsuperuser
Start the local server to test the project:
$ python manage.py runserver
Now you can access the API at: http://127.0.0.1:8000/.
Below are the main endpoints of the API:
| Resource | Endpoint | Description |
|---|---|---|
| Artists | http://127.0.0.1:8000/artists/ |
Manage artists |
| Albums | http://127.0.0.1:8000/albums/ |
Manage albums |
| Genres | http://127.0.0.1:8000/genres/ |
Manage music genres |
| Songs | http://127.0.0.1:8000/songs/ |
Manage songs |
| Playlists | http://127.0.0.1:8000/playlists/ |
Manage playlists |
This project is an API designed to manage music-related data. You can use it as a foundation to build custom front-end applications or to practice development with Django REST Framework.
📢 Objective: Provide a simple and functional backend for music-based applications.
🎧 Target Audience: Students and developers interested in learning front-end development who need a backend.
Feel free to reach out via LinkedIn for questions, suggestions, or collaborations:
PORTUGUESE
🎧 Bem-vindo ao Trackbase API!
Este projeto foi desenvolvido com o Django REST Framework (DRF) para criar uma API que gerencia artistas, álbuns, gêneros, músicas e playlists. Ele é perfeito para praticar integrações com front-ends personalizados e explorar o mundo das APIs!
Siga os passos abaixo para configurar e rodar o projeto localmente:
$ git clone <URL_DESTE_REPOSITORIO>
Acesse o diretório do projeto $ cd trackbase-api
⚡ É recomendado utilizar um ambiente virtual para manter as dependências isoladas.
Crie o ambiente virtual $ python -m venv venv
Ative o ambiente virtual Windows $ venv\Scripts\activate
Linux/MacOS $ source venv/bin/activate
As dependências necessárias estão listadas no arquivo requirements.txt. Use o seguinte comando para instalá-las:
Instale as dependências do projeto $ pip install -r requirements.txt
Crie as tabelas no banco de dados rodando as migrações:
$ python manage.py migrate
Para acessar a interface de administração do Django, crie um superusuário:
$ python manage.py createsuperuser
Inicie o servidor local para testar o projeto:
$ python manage.py runserver
Agora, você pode acessar a API em: http://127.0.0.1:8000/.
Abaixo estão os principais endpoints da API:
| Recurso | Endpoint | Descrição |
|---|---|---|
| Artists | http://127.0.0.1:8000/artists/ |
Gerenciar artistas |
| Albums | http://127.0.0.1:8000/albums/ |
Gerenciar álbuns |
| Genres | http://127.0.0.1:8000/genres/ |
Gerenciar gêneros musicais |
| Songs | http://127.0.0.1:8000/songs/ |
Gerenciar músicas |
| Playlists | http://127.0.0.1:8000/playlists/ |
Gerenciar playlists |
Este projeto é uma API criada para gerenciar dados relacionados à música. Você pode usá-la como base para construir aplicações front-end personalizadas ou para prática de desenvolvimento com Django REST Framework.
📢 Objetivo: Fornecer um backend simples e funcional para aplicações baseadas em música.
🎧 Público-alvo: Estudantes e desenvolvedores interessados em aprender Front-end e precisam de um backend.
Entre em contato comigo pelo LinkedIn para dúvidas, sugestões ou colaborações: