In this group project, we have designed and implemented a Facebook style web app by building upon an existing MERN project. Over two weeks we had to familiarise ourselves with the inherited codebase and then design user stories and carefully plan tickets to give us an appropriate amount of work during the limited time.
The original code allowed a user to:
- Sign up
- Sign in
- Sign out
- View a list of posts
We have made changes to allow a user to:
- Create a post
- Like a post
- Comment on a post
- View a randomly assigned avatar image next to their posts
- MongoDB
- Express
- React
- Node
- Mongoose for modelling objects in MongoDB
- JSON Web Tokens for user validation
- Cypress (front end)
- Jest (api backend)
# Clone this repository
git clone https://github.com/lplclaremont/trelloship_of_the_string
cd trelloship_of_the_string
# Install the required dependencies
cd api
npm install
cd ../frontend
npm install
# Install and start MongoDB
brew tap mongodb/brew
brew install mongodb-community@5.0
brew services start mongodb-community@5.0
# Start the backend server
cd api
JWT_SECRET=SUPER_SECRET npm start
# In a new terminal start the frontend server
cd frontend
npm startYou should now be able to open your browser and go to http://localhost:3000/ to create a new user by clicking sign-up.
Navigate to login and start making posts and interacting with existing ones!
Below are screenshots of the landing page and posts page
Start the server in test mode (so that it connects to the test DB)
cd api
JWT_SECRET=SUPER_SECRET npm run start:testThen run the tests in a new terminal session
cd api
JWT_SECRET=SUPER_SECRET npm run testStart the server in test mode (so that it connects to the test DB)
cd api
JWT_SECRET=SUPER_SECRET npm run start:testThen start the front end in a new terminal session
cd frontend
JWT_SECRET=SUPER_SECRET npm startThen run the tests in a new terminal session
cd frontend
JWT_SECRET=SUPER_SECRET npm run test