StudyAlly
Description: StudyAlly is a web application designed to facilitate collaborative studying among students. The project consists of both frontend and backend components. The frontend is built using React with Vite, providing a responsive and interactive user interface. The backend is powered by Django, offering robust data handling and authentication functionalities.
Project Structure:
- studyAlly/
- StudyAlly/: Backend Django project.
- accounts/: Django app handling user authentication and profile management.
- groups/: Django app managing study groups and related functionalities.
- StudyAlly_Frontend/: Frontend React project.
Setup Instructions:
-
Backend Setup:
- Navigate to the
StudyAlly/folder. - Ensure Python and Django are installed.
- Install dependencies using
pip install -r requirements.txt. - Apply database migrations with
python manage.py migrate. - Run the backend server using
python manage.py runserver.
- Navigate to the
-
Frontend Setup:
- Navigate to the
StudyAlly_Frontend/folder. - Ensure Node.js and npm are installed.
- Install dependencies using
npm install. - Start the development server with
npm run dev.
- Navigate to the
-
Accessing the Application:
- Once both the backend and frontend servers are running, the application can be accessed in a web browser at the specified address (default is
http://localhost:3000/for frontend andhttp://localhost:8000/for backend).
- Once both the backend and frontend servers are running, the application can be accessed in a web browser at the specified address (default is
Features:
- User Authentication: Users can sign up, log in, and manage their profiles.
- Study Groups: Create, join, and manage study groups for collaborative learning.
- Resource Sharing: Share study materials, notes, and resources within study groups.
- Real-time Collaboration: Collaborate with other group members in real-time through chat or document editing features.
- Notifications: Receive notifications for new group invitations, messages, and updates within study groups.
- Search Functionality: Easily search for study groups, resources, and other users within the platform.
- User Profiles: View and customize user profiles with information, interests, and study preferences.
- Accessibility: Ensure accessibility standards are met for users with disabilities, providing an inclusive user experience.
- Mobile Responsiveness: Optimize the application for mobile devices to enable studying on the go.
Contributing:
- Contributions to the StudyAlly project are welcome! Please fork the repository, make your changes, and submit a pull request.
Authors:
Acknowledgements:
- Special thanks to the developers and contributors of Django, React, and Vite for providing powerful frameworks and tools for building web applications.