Hightechu Academy Group Project 🤘

HighTechU Group Project

Papyrus City

Website ⭐

Live Demo

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

Promo 😀

Getting Started 🤔

Requirements 🐶

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

Obtaining the Project 🐱

1. Open the terminal

2. Change into your working directory

cd working/directory

3. Clone the repository

git clone URL

4. Change into the repository

cd REPO_NAME

Running the Application 🦌

1. Install the node_modules

npm install

2. Run the application locally

node .

3. 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 🌊

1. Add Custom Models

lb model

2. 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.

1. Log into Heroku

2. Create a new app

3. Setup Deploy with GitHub (Deploy -> GitHub -> Select Repository)

4. Setup a mongodb datasource for loopback using mLab MongoDB addon

5. 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 📘

• GitHub
• GitHub Help
• GitHub Markdown Help
• GIT Command Line Cheat Sheet
• Heroku
• Heroku Documentation
• Loopback
• Loopback Documentation

Support ❔

For support, visit the HighTechU Academy Slack.