Welcome to the BiT-Forum Backend repository! This project is the backend for an online forum dedicated to the Bahir Dar Institute of Technology (BiT), built using the Django REST framework.
You can find the frontend of this project at https://github.com/gdscbahirdar/forum-frontend
We built this forum as part of our final-year project but wanted to open-source it to foster collaboration and learning among BiT students and teachers. By contributing to this project, students can gain hands-on experience with real-world software development and help enhance the forum with new features and improvements.
We envision this forum as a comprehensive platform for students and teachers to engage in discussions, share resources, and collaborate on projects. Your contributions can help make this vision a reality, whether by adding new features, improving existing functionality, or fixing bugs.
- Role-based access control for students, teachers, and faculty admins of the university.
- Question and answer platform with features to upvote, downvote, comment, etc.
- Resource sharing. You can share files, assignments, notes, links, etc.
- Reward system through badges and reputation. Similar to StackOverflow.
- Notification updates.
- AI assistant and AI-driven profanity checks.
- Django
- Django REST framework
- PostgreSQL
First Clone this repository to your local machine and create a .env file. Copy the contents of .env.example file found in the root directory of the project to .env and update the environment variables accordingly. Then you can start the project by following the commands below:
- Create a Python virtual environment and activate it.
- Open up your terminal and run the following command to install the packages used in this project.
$ pip install -r requirements.txt- Set up a Postgres database for the project.
- Run the following commands to set up the database tables and create a superuser.
$ python manage.py migrate
$ python manage.py createsuperuser- Start the development server:
$ python manage.py runserverAPI documentation is provided using Redoc. You can access the documentation at http://localhost:8000 once the server is running.
We welcome the BiT community to contribute to this project whether that is providing new features or bug fixes. Please see our CONTRIBUTING.md for details on how to contribute to this project.
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions or feedback, please open an issue or contact the project maintainers.
Thank you for using BiT-Forum Backend! Happy coding!