A brief description of what this project does and who it's for
A web application designed to help students manage their study groups, schedules, and subjects efficiently, built using React.
By Oliver (Oliver9105)
Study Buddy is a minimalist application that demonstrates core React concepts including components, state management, and routing with React Router. Users can create profiles, join or form study groups, schedule study sessions, and manage subjects. This project serves as a learning tool for mastering React development.
- Home page displaying a welcome message and navigation links.
- User profile creation and management.
- Study group creation and member management.
- Scheduling study sessions with study partners.
- Adding and managing subjects.
- Responsive and clean UI design.
- A computer, tablet, or phone.
- Access to the internet.
- A modern web browser.
Visit the deployed application at: Study Buddy App
The live site allows you to:
- Browse and create profiles.
- Form and join study groups.
- Schedule and manage study sessions.
- Add and manage subjects.
If you want to run the project locally, you'll need:
- Node.js installed on your computer.
- Basic understanding of React JS.
- Code editor (VS Code recommended).
- Terminal/Command Line.
-
Clone this repository using:
git clone https://github.com/Oliver9105/study-groups-app.git
or by downloading a ZIP file of the code.
-
Navigate to the project directory:
cd study-buddy -
Install the required dependencies:
npm install
-
Run the JSON Server:
json-server --watch db.json --port 5000
-
Run the development server:
npm start
-
Open your browser and visit
http://localhost:3000
- React JS
- JSON Server
- CSS3
- JavaScript (ES6)
-
Repository: Backend API Repository
-
Deployed API Live API URL
If you have any questions, suggestions, or need assistance, please contact:
- Email: Olivercher1000@gmail.com
MIT License © 2024 Oliver (Oliver9105)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.