Skip to content

Commit 6e2bfc7

Browse files
authored
Update README.md
1 parent bb58672 commit 6e2bfc7

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

Diff for: README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# BiT-Forum Backend
22

3-
Welcome to the BiT-Forum Backend repository! This project serves as the backend for an online forum dedicated to the Bahir Dar Institute of Technology (BiT), built using Django REST framework.
3+
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.
4+
5+
![API Doc](https://github.com/user-attachments/assets/e9637d9b-a48e-46c5-bba8-54d80cf6b300)
6+
7+
You can find the frontend of this project at https://github.com/gdscbahirdar/forum-frontend
48

59
## Purpose
610

7-
We built this forum as part of our final-year project but we 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.
11+
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.
812

913
## Vision
1014

11-
We envision this forum to be 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.
15+
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.
1216

1317
## Features
1418

1519
- Role-based access control for students, teachers, and faculty admins of the university.
1620
- Question and answer platform with features to upvote, downvote, comment, etc.
17-
- Resource sharing. You can share files, assignments, notes, links etc.
21+
- Resource sharing. You can share files, assignments, notes, links, etc.
1822
- Reward system through badges and reputation. Similar to StackOverflow.
1923
- Notification updates.
2024
- AI assistant and AI-driven profanity checks.
@@ -37,7 +41,7 @@ $ pip install -r requirements.txt
3741
```
3842

3943
3. Set up a Postgres database for the project.
40-
4. Run the following commands to setup the database tables and create a superuser.
44+
4. Run the following commands to set up the database tables and create a superuser.
4145

4246
```shell
4347
$ python manage.py migrate
@@ -52,7 +56,7 @@ $ python manage.py runserver
5256

5357
## API Documentation
5458

55-
API documentation is provided using redoc. You can access the documentation at http://localhost:8000 once the server is running.
59+
API documentation is provided using Redoc. You can access the documentation at http://localhost:8000 once the server is running.
5660

5761
## Contributing
5862

0 commit comments

Comments
 (0)