Bettah

Contributors

• Sam Button
• Gawain Hewitt
• Archie Martin
• Russell Morbey
• Tom O'Neill
• Simon Tinsley

Description

This is a clone of Facebook built using the Express.js framework for Node.js, with a MongoDB database and Handlebars templates for the front end. It was a group project as part of Makers Academy and we named our website Bettah. Like Meta, but Bettah!

It uses:

• Express web framework for Node.js.
• Nodemon to reload the server automatically.
• Handlebars to render view templates.
• Mongoose to model objects in MongoDB.
• MongoDB our database.
• ESLint for linting.
• Jest for testing.
• Cypress for end-to-end testing.
• Javascript our coding language.
• [HTML]
• [CSS]

Card wall

MVP, design and planning

• A user can make a post on acebook.
• A user can view a post on acebook.
• A user can sign up, and then log into acebook.

Team Approach

Work hours

• Start time 10am
• Lunch 1pm - 2pm
• End day 5:30pm

Pairing

• Breaks decided amongst pairs.

• Two pairing slots.

• Morning 10.15am - 1pm.

• Afternoon 2pm - 5:30pm.

Daily stand ups and retros.

• Stand ups. 10am-10:15am.

• Retro. 5:30pm.

• Additional Stand ups before or after lunch for planning and estimation of tickets. When needed.

Demo Photos

Home page / Login Page

Sign up Page (Modal)

Timeline

Future Improvements

• Users can friend each other.
• Use cloud server for database
• Deploy website on Heroku

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 version of Node.js, currently 18.1.0.

   nvm install 18
   

How to run locally

1. Fork this repository
2. Clone your fork to your local machine
3. Install Node.js dependencies

   npm install
   

4. Install MongoDB

   brew tap mongodb/brew
   brew install [email protected]
   

5. Start MongoDB

   brew services start [email protected]
   

Start

1. Start the server

   npm start
   

2. Browse to http://localhost:3000

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_test MongoDB database, so that integration tests do not interact with the development server.

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

MongoDB Connection Errors?

Some people occasionally experience MongoDB connection errors when running the tests or trying to use the application. Here are some tips which might help resolve such issues.

• Check that MongoDB is installed using mongo --version
• Check that it's running using brew services list