markdownCopy code
Django StudyBud is an interactive web application that allows users to create and join study rooms to discuss specific topics. It provides a platform for collaborative learning and knowledge sharing.
-
User Registration and Authentication: Users can create accounts, log in, and manage their profiles.
-
Room Creation: Users can create study rooms for specific topics, adding descriptions and categories.
-
Real-time Chat: Each room features a real-time chat functionality for users to discuss and collaborate.
-
Room Discovery: Users can search and discover study rooms based on categories and keywords.
-
Notifications: Users receive notifications for new messages and room updates.
- Django
- Django Channels (for real-time chat)
- HTML, CSS, JavaScript
- SQLite (as the database)
- Other relevant dependencies (list them)
Follow these steps to set up and run the Django StudyBud app on your local machine:
-
Clone the repository:
git clone https://github.com/carloskim123/django_studybud_app.git`
-
Change into the project directory:
django_studybud_app
-
Install the project dependencies:
pip install -r requirements.txt
-
Set up the database:
python manage.py migrate
-
Create a superuser to manage the admin panel:
python manage.py createsuperuser
-
Start the development server:
python manage.py runserver
-
Access the admin panel at
http://localhost:8000/admin/
and log in with the superuser account to manage rooms and users. -
Visit the StudyBud web app at
http://localhost:8000/
and start creating or joining study rooms!
You can configure various settings in the settings.py
file, including database settings, authentication, and email setup.
We welcome contributions to make Django StudyBud even better. Feel free to open issues, submit pull requests, or suggest improvements.
If you have questions or need assistance, please contact Carlos Kim.
Happy learning and collaborating!