Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 2.15 KB

README.md

File metadata and controls

83 lines (53 loc) · 2.15 KB
Raw

Not Quite Genius (NQG)

Not Quite Genius is a one stop source for lyrics to your favorite songs.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

In order to run this application locally for testing purposes, Git, node.js (which comes with npm), and a database system (ie. Postgresql) is required.

Installing

# Clone this repository
$ git clone https://github.com/JhonathanAde/NQG-NotQuiteGenius.git
  1. Create a database named nqg_app and an owner named nqg with a password
  2. Create .env file at the root of this project, add environment variables provided in .env.example to .env file
  3. Initialize your database password to the SECRET_KEY variable in your .env file.
# Go into the repository, install backend dependencies at the root
$ pip install

# Migrate database tables and seed data.  Make sure you are at the root of the project (backend).
$ pipenv shell
$ flask db migrate
$ flask db upgrade
$ flask seed all

# Go into react-app directory, install frontend dependencies 
$ npm install

Running Application

# Run app from within react-app directory
$ npm start

# Go to root directory and run Flask 

# (Use the command below if you are not already in the pipenv shell (virtual environment))
$ pipenv run flask run 

# (Use the command line below if you are already in the virtual environment)
$ flask run

Application should open up in your browser from localhost:3000

Built With

  • React - front-end
  • Python (Flask SqlAlchemy, Alembic) - back-end
  • Postgresql - database

Contributing

  1. Clone repo: $ git clone https://github.com/JhonathanAde/NQG-NotQuiteGenius.git
  2. Create a new branch: $ git -b name_of_branch.
  3. Make changes
  4. Submit Pull Request with description of changes

Authors

Acknowledgments

  • App Academy for helping us develop the skills necessary to create this app.