Live Version: Study Buddy
Test Version: Study Buddy Test
Study Buddy is an application designed to help students connect and collaborate with others for exam preparation. By finding study partners who share the same course and exam schedule, students can form study groups and enhance their learning experience.
Our vision is to provide students with an easy and efficient way to connect with each other, so they can succeed academically and feel more confident in their exam preparation.
-
Bishnu Dev-Github Account
-
Lukelo Luoga -Github Account
-
Paula Seraphim -Github Account
-
Yewon Song -Github Account
The idea for Study Buddy came from our own experiences as students. We often found ourselves struggling to find study partners who were taking the same course and preparing for the same exams. We realized that there was a need for an application that would make it easy for students to connect with each other and form study groups. So, we decided to create Study Buddy.
If you would like to contribute to Study Buddy, please read our CONTRIBUTING.md document. We welcome all contributions, including bug reports, feature requests, and pull requests.
To run the tests, run npm test from back-end folder.
To build the project:
- Ensure the
.envfiles are in place - Run
cd front-end && npm install && npm run build && cd ..: This will build the react app - Run
cd back-end && rm -r -f client && cd .. && mv front-end/build back-end/client: This will move the react build files to the back-end folder - Run
cd back-end && npm install && npm start: This will start the server
- Our app has two versions: a development version ("test") that contains the latest features under review, and a production one ("prod") that is the most stable and reliable release.
- We use a continuous integration and deployment (CI/CD) pipeline to automate the deployment process.
- The pipeline is triggered when a pull request is opened into the master branch. The pipeline builds the project, and deploys the app to the test server.
- When the pull request is merged into the master branch, the pipeline builds the project, and deploys the app to the production server.
