musix-match

Getting started

Pre-requisites

• NodeJS installed on your system
• MongoDB installed on your system

Installation

1. Clone the repository
2. Add an .env file to the root of the backend project
3. Populate the .env file with the following:

MONGODB_URI = 'mongodb://localhost:27017/musix-match' (or your own MongoDB URI)
PORT = 3001
SESSION_SECRET = '{your own secret}'
MUSIXMATCH_API_KEY = '{your own MusixMatch API Key}';

4. Run npm run install:all to install dependencies
5. Run npm run start to start the server
6. Run npm run test to run tests

Features

Frontend

• Responsible for displaying the UI and handling user input
• Read the frontend README.md for more detail

Backend

• Responsible for handling requests and interacting with the database and MusixMatch API
• Read the backend README.md for more detail

Shared

• Shared resources (types, interfaces, etc) are stored in the shared directory