README-template.md

Capstone Project Title (to do now)

One line description of what this app is doing and who is it for

1. Working Prototype (to do later)

(Example) You can access a working prototype of the React app here: https://your-app-client.herokuapp.com/ and Node app here: https://your-app-server.herokuapp.com/

2. User Stories (to do now)

This app is for two types of users: a visitor and a logged-in user

(Example) Landing Page

• as a visitor
• I want to understand what I can do with this app (or sign up, or log in)
• so I can decide if I want to use it

3. Functionality (to do now)

The app's functionality includes:

• (Example) Every User has the ability to create an account

4. Technology (done)

• Front-End: HTML5, CSS3, JavaScript ES6, React
• Back-End: Node.js, Express.js, Mocha, Chai, RESTful API Endpoints, Postgres
• Development Environment: Heroku, DBeaver

5. Wireframes (to do now)

(Example) Landing Page
Register Page

6. Front-end Structure - React Components Map (to do later)

• (Example) Index.js (stateless)
  • App.js (stateful)
    • LandingPage.js (stateful) - gets the "prop name" and the "callback prop name" from the App.js
      • Login.js (stateful) -
      • Register.js (stateful) -
    • Navbar.js (stateless) -

7. Back-end Structure - Business Objects (to do later)

• (Example) Users (database table)
  • id (auto-generated)
  • username (email validation)
  • password (at least 8 chars, at least one alpha and a special character validation)

8. API Documentation (to do later)

API Documentation details:

• (Example) get all users

Screenshots (to do later)

(Example) Landing Page
Register Page

Development Roadmap (to do later)

This is v1.0 of the app, but future enhancements are expected to include:

• (Example) add more functionality

How to run it (done)

Use command line to navigate into the project folder and run the following in terminal

Local React scripts

• To install the react project ===> npm install
• To run react (on port 3000) ===> npm start
• To run tests ===> npm run test

Local Node scripts

• To install the node project ===> npm install
• To migrate the database ===> npm run migrate -- 1
• To run Node server (on port 8000) ===> npm run dev
• To run tests ===> npm run test