StudySync is a collaborative learning platform designed to help students and educators engage with course materials, share knowledge, and communicate effectively.
This repository contains both the frontend and backend code for the StudySync application.
- Features
- Usage
- Technologies Used
- Prerequisites
- Setup & Running the Application
- Documents
- Collaborators
- Course Selection: Users can view a list of their courses and select a course to view its associated posts.
- View Posts: Users can view posts related to a selected course, including the title and content of each post.
- Create Post: Users can create new posts for a selected course.
- Edit Post: Users can edit their own posts.
- Delete Post: Users can delete their own posts.
- Upon accessing the application, users will be prompted to log in with their credentials.
- After logging in, users will see a list of their courses on the sidebar.
- Users can click on a course to view posts related to that course.
- Users can create new posts, edit their existing posts, and delete their posts as needed.
- React: JavaScript library for building user interfaces.
- React Router: Library for handling navigation in React applications.
- Fetch API: Interface for fetching resources across the network.
- CSS: Styling the user interface.
- React Responsive Carousel: Library for implementing a responsive carousel component.
Before you begin, ensure you have met the following requirements:
- Node.js installed on your local machine.
- npm or yarn package manager installed.
- SQL database management system installed (e.g., MySQL, PostgreSQL).
To set up the project, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/your-username/StudySync.git
-
Follow the setup instructions provided in the
frontend
andbackend
directories.- For Frontend Setup, refer to the Frontend README.
- For Backend Setup, refer to the Backend README.
Once both servers are running, you can access the StudySync application by visiting http://localhost:3000
in your web browser.
- Project Proposal
- Project Final Report
- Requirement Tracability Matrix (RTM)
- Frontend Tests
- Backend Tests
- All Tests as a PDF
- Sequence Diagrams
- System Architecture
- Databases Designs
- Arvind Krishnaa - Arvind's GitHub Profile
- Varshiny Gogulanathan - Varshiny's GitHub Profile
- Anfaal Mahbub - Anfaal's GitHub Profile
- Adhil Ashraf - Adhil's GitHub Profile
- Al Farhana Siddique - Farhana's GitHub Profile
- Mehvish Fatima Shakeel - Mehvish's GitHub Profile