Xaroz / music-on

The Music On API provides an easy way to manage music resources including tracks, genres, playlists, and user accounts. Built with Node.js, Express, MongoDB, TypeScript, and AWS S3 for cloud storage.

music-on

Description

The Music On API main objective is to allow an easier and complete solution for managing music resources. Currently the main features of the project are:

1. Getting and uploading tracks
2. Adding tracks to playlists
3. Becoming an artist to upload music
4. Organizing tracks with genres
5. Secure endpoints and control access with authentication and authorization
6. Filters and pagination on resources

Main technologies used

1. Node-JS & Express
2. MongoDB & Mongoose
3. Typescript
4. Cloud storage with AWS-S3

How to run the project

With npm installed on your machine, install project dependencies running the following command:

npm i

Create a .env file in the root of the project that holds the variables in the this file

Development mode

Make sure in your .env to add NODE_ENV=development and run the following command

npm run dev

Production mode

Make sure in your .env to add NODE_ENV=production and run the following command

npm run build
npm start

API Documentation

WIP

Contributing

Contributions are welcome! If you find any issues or want to add new features, feel free to open a pull request.

License

MIT