Acebook

This is a Node.js template for the Acebook engineering project.

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.
• ESLint for linting.
• Jest for testing.
• Cypress for end-to-end testing.

Card wall

https://github.com/lucypoulton/acebook/projects/1

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

   nvm install 16
   

Set up your project

1. Fork this repository
2. Rename your fork to acebook-<team name>
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.4
   

7. Start MongoDB

   brew services start mongodb-community@4.4
   

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

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
• Try swapping localhost, everywhere that it appears in your codebase, with 127.0.0.1. It might be surprising but this does sometimes make a difference.

If you have issues that are not resolved by these tips, please reach out to a coach and, once the issue is resolved, we can add a new tip!

Working practices

• Start at 10am followed by standup
• Take 1 hour lunch whenever
• Finish at 4 for daily retro
• Work until 5:30 independently