Created by Likai Liu, Justin Bennett.
Neptune is a "smart" activity list that auto-categorizes user-inputted tasks and returns information based on API calls. Neptune is a single-page app built in Node with Express and Axios supporting the back-end, jQuery/Ajax w/ SASS CSS to build the front-end and PostgreSQL to handle the local database.
When given input to assess, Neptune makes calls to multiple APIs to gather data and decide which API is appropriate. It will then categorize the task by the type of activity based on the API results and also grab additional information that is put into an informational card that can be toggled open or closed.
- Nodejs
- jQuery
- Axios
- Sass
- PostgreSQL
- Clone the repo
- Install all dependencies using the
npm install
command. - Create the
.env
by using.env.example
as a reference:cp .env.example .env
- Update the .env file with your relevant local information.
- Install dependencies:
npm i
- Reset database:
npm run db:reset
- Run the server:
npm run start
- Visit
http://localhost:8080/
- Node 10.x or above
- NPM 5.x or above
- PG 6.x
- Yelp API Key
- TMDB API Key
- OMDB API Key