Skip to content

Latest commit

 

History

History

backend

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Laughable Lyrics backend

NodeJS Express backend powering the REST API for the app

Installation

  1. Clone repo
  2. cd Laughable-Lyrics/backend
  3. npm install
  4. Install and start mysql database (Mac, Windows)
  5. Copy the env file: cp .env.example .env - fill in all of the secret values, including your local database info
  6. Download gcp credentials file from Google Cloud Platform Console after setting up a translation project, and specify this file's location in the GOOGLE_APPLICATION_CREDENTIALS environmental variable in .env
  7. Specify your GCP project ID in GOOGLE_PROJECT_ID environmental variable in .env
  8. Run script to create database and tables: ./src/database/migrate.sh
  9. Start the server:
    • Normal start: npm run start
    • Auto reload when files are changed: npm run watch (requires nodemon - npm install -g nodemon)