Hightechu Academy Group Project

HighTechU Group Project

Papyrus City

Website

Mini Pitch

A website for teens to find books they enjoy and to discuss and recommend books to friends, online or otherwise.

Problem Statment

Most book websites have a majority of adult or kid readers, even on books aimed at teens. This website aims to focus on ages 13-20, which are disproportionately under-represented on many other sites.

User Stories

I want my users to be able to sign up and log in.
I want my users to be able to search for books.
I want my users to be able to read books online.
I want my users to be able to review books.
I want my users to be able to read reviews from others.

Website Pages

Home Page -> index.html
Login / Register Page -> login-register.html
Book Page -> book-page.html
Make a Review Page -> makeareview
Search Page -> search.html
Results Page -> results.html
Personal User Page -> user-page.html

Getting Started

Requirements

git
Node.js
npm (Installed with Node.js)
LoopBack CLI Tool

Obtaining the Project

Open the terminal
Change into your working directory

cd working/directory

Clone the repository

git clone URL

Change into the repository

cd REPO_NAME

Running the Application

Install the node_modules

npm install

Run the application locally

node .

Head over to http://0.0.0.0:3000 and http://0.0.0.0:3000/explorer in the browser of your choice.

Adding Custom Models

Add Custom Models

lb model

Follow command prompts

Deploying

We are using Heroku to host our application. The following steps should only be done once. After setting up the application to deploy with GitHub, everytime you push to the master branch you will re-deploy your application.

Log into Heroku
Create a new app
Setup Deploy with GitHub (Deploy -> GitHub -> Select Repository)
Setup a mongodb datasource for loopback using mLab MongoDB addon
Replace the server/datasources.json with the following:

{
  "db": {
    "db": {
      "url": "mongodb://URL",
      "name": "mongoDS",
      "useNewUrlParser": true,
      "connector": "mongodb"
    }
  }
}

Make sure to replace URL with the URL the Heroku mLab MongoDB addon provides.

Resources

Support

For support, visit the HighTechU Academy Slack.