Git Product home page Git Product logo

django_studybud_app's Introduction

markdownCopy code

Django StudyBud App

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.

Features

  • 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.

Technologies Used

  • Django
  • Django Channels (for real-time chat)
  • HTML, CSS, JavaScript
  • SQLite (as the database)
  • Other relevant dependencies (list them)

Installation

Follow these steps to set up and run the Django StudyBud app on your local machine:

  1. Clone the repository:

    git clone https://github.com/carloskim123/django_studybud_app.git` 
    
  2. Change into the project directory:

    django_studybud_app

  3. Install the project dependencies:

    pip install -r requirements.txt

  4. Set up the database:

    python manage.py migrate

  5. Create a superuser to manage the admin panel:

    python manage.py createsuperuser

  6. Start the development server:

    python manage.py runserver

  7. Access the admin panel at http://localhost:8000/admin/ and log in with the superuser account to manage rooms and users.

  8. Visit the StudyBud web app at http://localhost:8000/ and start creating or joining study rooms!

Configuration

You can configure various settings in the settings.py file, including database settings, authentication, and email setup.

Contributing

We welcome contributions to make Django StudyBud even better. Feel free to open issues, submit pull requests, or suggest improvements.

Contact

If you have questions or need assistance, please contact Carlos Kim.

Happy learning and collaborating!

django_studybud_app's People

Contributors

carloskim123 avatar

Stargazers

 avatar Walter Kiprono avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.