Rules For Pushing

Before making a pull request. From your branch:

1. stage any changes git add . & git commit -m "meaningful message"
2. git checkout main
3. update your local main git pull origin main5
4. go back to your branch git checkout branch-name
5. merge your branch with main git merge main
6. resolve any conflicts locally; speak with the person who wrote the conflicting code if necessary
7. repeat step 1
8. open a PR git push origin branch-name

To add, if you ever want to make your branch available for everyone else, simply:

• git push origin branch-name just don’t open up a PR after, and everyone can then check out your branch

Collaborator User Names

• Louis - Loo-Ashworth
• Adrian - adrianHards
• Laura - Lmason14
• Joe - Joecunliffe98
• Terry - terenceroach
• Lisa - lisaoausb
• Emma - emmadavids
• Joan -JoanKalanzi

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

Miro Board

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
   

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 [email protected]
   

   Note: If you see a message that says If you need to have [email protected] first in your PATH, run:, follow the instruction. Restart your terminal after this.
7. 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

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!

Requirements Bcrypt - for pw hashing Validator Cloudinary Multer dotenv method-override