Table of Contents

1. Project Summary
   • Wiki
   • Tech Stack
2. Sample Features
3. Getting Started
4. Roadmap
5. Contact Me

Project Summary

TuneNimbus is a SoundCloud clone. Here's their website: SoundCloud. TuneNimbus is an online audio distributiion platform and music sharing website that enables its users to upload, promote, and share music, as well as discover new music and share their opinions. Check it out here

Wiki Links

• Backend Routes (API Documentation)
• Database Schema
• Feature List
• Redux Store Shape

Tech Stack

Frameworks, Platforms, and Libararies:

Database and Host:

Sample Features

Landing Page

You can play some sample songs, log in, and create an account on this page. There is also a demo user button on the log-in modal for easier access to the website.

Upload a Song

Add Song to a Playlist

Getting Started

To get a local copy up and running follow these simple example steps.

1. Clone the repo:

   SSH version:

   git clone git@github.com:jakezmat/API-Project.git

   or

   HTTPS version:

   git clone https://github.com/jakezmat/API-Project.git

2. Navigate into the backend folder and run the following command.

   npm install

3. Use the .env.example file to create a .env file at the root of the backend folder and change the appropriate fields.

   cp .env.example .env

4. Migrate and seed the files while in the backend folder using the following commands:

   npm run migrate

   npm run seed

5. Run the following command to start the backend server.

   npm start

6. In a new terminal, navigate into the frontend folder and use the following command.

   npm install

7. Run the following command to start the frontend server.

   npm start

8. Go to localhost:3000 in your browser to view the site. Ensure that both frontend and backend servers are running.

Roadmap

• Songs
  • Create a song
  • Load all song
  • Load a song's details
  • View a list of the current user's songs
  • Edit song details
  • Delete a song
• Playlists
  • Create a playlist
  • See list of the current user's playlists
  • Add a song to a playlist
  • Edit a playlist
  • Delete a playlist
• Comments
  • Create a comment
  • See all comments of a song
  • Edit a comment
  • Delete a comment
• Albums
  • Get all Albums
  • Get all Albums created by the Current User
  • Get all Albums of an Artist from an id
  • Get details of an Album from an id
  • Create an Album
  • Edit an Album
  • Delete an Album
• Search
  • Filter song search by:
    • page
    • size
    • title
    • date

Contact Information

Jake Matillano (he/him/his) LinkedIn GitHub