Table of Contents

• User Stories
  • Built With
• Quickstart
  • Install Node.js
  • Set up for the project
  • Start
  • Test
  • Start test server
• Card wall
• Contributing
• Team Members
• Trello Board
• Retro Board
• Reflections about our journey
• Acknowledgements

Acebook

User Stories

• (1) Sign Up
• (2) Log In
• (3) Log Out
• (4) List Users
• (5) Send Friend Request
• (6) Accept Friend's Request
• (7) View Feed
• (8) Posting to Feed

(1)
As a user of AceBook, 
I want to be able to sign up,
So that I can access the services of the site.

(2)
As a user of AceBook,
I want to be able to login,
So that I can access my account.

(3)
As a user of AceBook,
I want to be able to logout,
So that I can protect the security of my account.

(4)
As a user of AceBook,
I want to be able to view a list of all users,
so that I can choose to add other users as friends.

(5)
As a user of AceBook,
I would like to be able to send a friend request,
So that I can become friends with another user.

(6)
As a user of AceBook,
I would like to be able to approve or deny a friend request,
So that I can decide who I want to be friends with.

(7)
As a user of AceBook,
I want to be able to view the feeds of my friends,
So that I can see what they are doing.

(8)
As a user of AceBook,
I want to be able to login and logout securely,
So that I know my details are stored safely.

(9)
As a user of AceBook,
I want to be able to post to my feed,
So that I can share things with my friends.

Built with:

• Express web framework for Node.js.
• Nodemon to reload the server automatically.
• Handlebars to render view templates.
• Mongoose to model objects in MongoDB.
• ESLint for linting.
• Jest for testing.
• Cypress for end-to-end testing.

Card wall

https://trello.com/b/agT0v9jj/acebook-rob-and-the-meerkats

Quickstart

Install Node.js

1. Install Node Version Manager (NVM)

   brew install nvm
   

   Then follow the instructions to update your ~/.bash_profile.
2. Open a new terminal
3. Install the latest long term support (LTS) version of Node.js, currently 10.16.3.

   nvm install 10.16.3
   

Set up for the project

1. Fork this repository
2. Rename your fork to https://github.com/robbaile/acebook-robAndTheMeerkats
3. Clone your fork to your local machine
4. Install Node.js dependencies

   npm install
   

5. Install an ESLint plugin for your editor. For example: linter-eslint for Atom.
6. Install MongoDB

   brew tap mongodb/brew
   brew install mongodb-community@4.2
   

7. Start MongoDB

   brew services start mongodb-community@4.2
   

Start

1. Start the server

   npm start
   

2. Browse to http://localhost:3000

Test

• Run all tests

  npm test
  

• Run a check

  npm run lint              # linter only
  npm run test:unit         # unit tests only
  npm run test:integration  # integration tests only

Start test server

The server must be running locally with test configuration for the integration tests to pass.

npm run start:test

This starts the server on port 3030 and uses the acebook MongoDB database, so that integration tests do not interact with the development server.

Team members

Rob

Jade

Migle

Lena

Project Repo

Trello board

Our Trello Board

Retro Board

Retro Board Week1

Retro Board Week2

Reflections about our journey

Blog post

Acknowledgements

• MongoDB using Mongoose (https://codeburst.io/things-i-wish-i-new-before-i-started-working-with-mongodb-c089d4b593db)