Skip to content

Latest commit

 

History

History
88 lines (65 loc) · 2.69 KB

README.md

File metadata and controls

88 lines (65 loc) · 2.69 KB
Raw

Sing me a Song API 🎧


About

Have you ever asked someone for a song recommendation? We have a tool to make this simple. Sing me a song is an API for music recommendation. If many people vote for a recommended song, it is more likely to be randomly recommended.


Technologies

Tools that were used in the project:

For more see the package.json


Getting Started

To run locally follow the steps

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
npm install npm@latest -g

Installation

  1. Create the root folder named sing-me-a-song and access it
mkdir sing-me-a-song && cd sing-me-a-song
  1. Clone the repo
git clone https://github.com/cgabrieu/sing-me-a-song-api.git
  1. Install dependencies with npm
npm install
  1. Create a database using the command below via postgres
CREATE DATABASE singmeasong;

  1. Automatically create all necessary tables to backend repo with dump.

  2. Connect your backend to the database, for that, rename the .env.example to .env.dev and fill in your data.

How to run

  1. Run using the command (remember to be on the repo):
npm run start:dev

How to contribute

  1. Fork the project.
  2. Create a new branch with your changes: git checkout -b feat/myFeatureName
  3. For each feature implemented, make a commit specifying what was done
  4. Submit your changes: git push -u origin feat/myFeatureName

Developer