BrainSomething

BrainSomething is a web application designed to [brief description of what your project does]. This project is part of the SOFTENG 310 course at the University of Auckland.

Technologies Used

• Frontend: React.js
• Backend: Node.js
• Database: MongoDB
• Package Manager: npm

Getting Started

Prerequisites

• Node.js (Recommended version: v21.7.3)
• npm (Included with Node.js installation)
• MongoDB (Recommended version: v8.0.0)

Installation and Setup

1. Clone the repository:

   git clone https://github.com/SOFTENG310-G5/BrainSomething.git
   

2. Backend Setup:

   • Navigate to the backend directory:

     cd backend
     

   • Install dependencies:

     npm install
     

   • Start the backend server:

     npm run dev
     

3. Frontend Setup:

   • Open a new terminal and navigate to the frontend directory:

     cd frontend
     

   • Install dependencies:

     npm install
     

   • Start the frontend application:

     npm start
     

4. Open your browser and go to http://localhost:3000 to view the application.

Note: Always start the backend server before running the frontend application.

Available Scripts

In the frontend project directory, you can run:

• npm start: Runs the app in development mode
• npm test: Launches the test runner
• npm run build: Builds the app for production
• npm run eject: Remove single build dependency from your project

For more details on these scripts, refer to the Create React App documentation.

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details on how to get started.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

A1 Contributors

• Stephen Fang
• Nicholas Lianto
• Thisuka Matara Arachchige
• Erica Ngin
• Hamish Patel
• Zion Suh

A2 Contributors

• Anna Lin
• Seth Yoo
• Tony Yin
• Minsung Cho
• Jaewon Kim
• Rusiru Dharmasekhara

Acknowledgements

Special thanks to our Project Supervisor, Kelly Blincoe, and James Tizard for guiding this project.

Getting Help

If you need assistance, please:

Check our Contributing Guidelines for information on how to report issues, and contacting