Music app

API for music streaming. The API has a range of features for authentication, authorization, music streaming, playlists management, and more. Here are some key features of the API:

• User authentication and authorization:

  • The API allows to authenticate using an access token generated through valid credentials. Additionally, the API also provides a token refresh feature to allow for renewal of the access token before expiration;

• Music Streaming:

  • The API supports real-time music streaming to provide a seamless listening experience to users;

• Playlists management;

  • Users can create and manage personal playlists, add or remove songs from playlists, and interect with other public playlists from other users by viewing it and adding it to its own playlist list;

• Search songs and playlists by tags:

  • The API provides a intuitive searching system to find related songs and playlists;

• Clear and concise documentation of all the endpoints with request and response examples:

  • The tecnical documentation fully cover all the API features and provides a starting point to interact with the API quickly;

• Technologies:

  • Typescript;
  • Express;
  • Typeorm;
  • MySql;
  • FFmpeg;
  • Joi;
  • JsonWebToken;
  • Multer;

API Docs

After setting everything up, you can find the API documentation by accessing https://localhost:3000/api/docs.

Getting started

• This project uses the ffmpeg package for get some information from the uploaded files, to run the project properly, install the package in your machine with your favorite package manager:
• Intallation with chocolatey:

choco install ffmpeg

The project was developed with the version 5.1.2 of ffmpeg, but should run properly in 6.0

With ffmpeg alredy installed, follow the below instructions to getting started with the project:

1. Create a folder to store the project;
2. Clone the github repository inside the folder:

git clone https://github.com/DavidEsdrs/music-app.git .

3. Install the modules with your favorite node package manager:

• Using npm:

npm install

• Using yarn:

yarn

Warning: If you prefer run the database instance at localhost, the project Uses MySql as database, make sure to install it before proceed. The project was developed with the mysql version 8.0.32 and uses features only avaiable in version >=8.0.16, to run the project properly, please install a mysql version higher than that;

4.1. If you use the mysql instance, run the mysql cli or application and create a database to run the project;

4.2. If you prefer run the database instance in a docker container, run:

docker compose up -d

This command run the container instance in background, if you want to check if the container is running, run docker ps, a mysql container must be running.

5. Create a .env.dev file inside the root of the project:

DATABASE_URL="<YOUR DATABASE URL>"
ACCESS_TOKEN_SECRET="<YOUR RANDOM ACCESS TOKEN SECRET>"
REFRESH_TOKEN_SECRET="<YOUR RANDOM REFRESH TOKEN SECRET>"
ACCESS_TOKEN_LIFESPAN="<ACCESS TOKEN LIFESPAN, RECOMMENDED 1200s (20min)>"
REFRESH_TOKEN_LIFESPAN="<ACCESS TOKEN LIFESPAN, RECOMMENDED 10d (10 days)>"
SERVER_PORT=4747
API_URL=<API URL>
FRONT_END_URL=<FRONT END URL>

Warning: Make sure to set DATABASE_URL to your mysql instance url, if you are runnning the mysql container in docker, just set the url as "mysql://user:password@localhost:3333/music-app" (mysql://{user}:{password}@localhost:{port}/{database})

6. Run the migrations to correctly set the tables:

npm run migration:run
OR
yarn migration:run

7. Run the api:

npm run dev
OR
yarn dev

Tip: You can check the swagger api documentation at "http://localhost:4747/api/docs"

Warning: If you changed the SERVER_PORT variable in the dotenv example, make sure to go to swagger.json file inside src folder and change the url variable to the server port that you set

...
"servers": [
        {
            "url": "http://localhost:{SERVER_POST}/api",
            "description": "API endpoint to production"
        }
    ],
...