Welcome to the Streaming Music Backend repository! This backend system is designed to handle the server-side functionalities required for a streaming music service. Below you'll find information on how to set up, configure, and use this backend system.

• Database: PostgreSQL and MongoDB
• FE repo

1. Features
2. Setup
3. Configuration
4. Usage
5. Contributing
6. License

• User Authentication: Allows users to register, login, and manage their accounts securely.
• Music Catalog Management: Supports the management of music tracks, albums, artists, and playlists.
• Streaming: Enables streaming of music tracks with efficient handling of audio data.
• Search Functionality: Provides search functionality to find music tracks, albums, and artists.
• Playlist Management: Allows users to create, modify, and delete playlists.
• User Interaction: Supports user interactions such as liking tracks, following artists, and sharing playlists.
• Administration: Provides administrative features for managing users, music catalog, and system settings.

Make sure you have installed Ruby and Rails. I recommend using rvm to manage Ruby and Rails versions.

To set up the project, follow these steps:

1. Clone the Repository: Clone this repository to your local machine using git clone.

2. Install Dependencies: Navigate to the project directory and install the dependencies using Bundler. Run bundle install to install all required gems.

3. PostgreSQL Setup: Set up the PostgreSQL name, password, required for the backend system in file config/database.yml.

4. MongoDB Setup: Setup the mongodb in file: config/mongoid.yml.

5. Environment Configuration: Configure environment variables required for the backend. These variables may include database connection settings, API keys, and security parameters. You can use a tool like dotenv to manage environment variables.

The backend system can be configured using environment variables. Here are the key environment variables you may need to set:

• ADMIN_JWT_PRIVATE_KEY: RSA PRIVATE KEY FOR ADMIN.
• ADMIN_JWT_PUBLIC_KEY: RSA PUBLIC KEY FOR ADMIN.
• USER_JWT_PRIVATE_KEY: RSA PRIVATE KEY FOR USER.
• USER_JWT_PUBLIC_KEY: RSA PUBLIC KEY FOR USER.
• ARTIST_JWT_PRIVATE_KEY: RSA PRIVATE KEY FOR ARTIST.
• ARTIST_JWT_PRIVATE_KEY: RSA PRIVATE KEY FOR ARTIST.
• RAILS_ENV: THE RAILS ENVIRONMENT.
• PORT: PORT OF APPLICATION.
• MONGODB_URL: MONGODB HOST URL

Or you can check in file .env.example

Make sure to set these variables according to your environment before starting the server.

Start application with command: rails s, application will run on port config in env (default is 3000)

Once the backend server is up and running, you can interact with it using the provided APIs.

The API documentation can be found:

• User api docs
• Artist api docs
• Admin page

You can use tools like Postman or curl to make API requests and test the functionalities provided by the backend system.

This project is licensed under the MIT License.