Skip to content

Commit 527ae6b

Browse files
updated readme
1 parent 5072463 commit 527ae6b

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ The project is built using following versions of softwares:
7373
7474
# Create a local administrator
7575
python manage.py createsuperuser
76+
77+
#seed database
78+
python manage.py loaddata data/*
7679
7780
# Now open a NEW TERMINAL and start tailwind in Algolyzer dir
7881
npm run tw_watch
@@ -114,6 +117,9 @@ The project is built using following versions of softwares:
114117
# Create a local administrator
115118
python manage.py createsuperuser
116119
120+
#seed database
121+
python manage.py loaddata data/*
122+
117123
# Now open a NEW TERMINAL and start tailwind in Algolyzer dir
118124
npm run tw_watch
119125
@@ -122,6 +128,23 @@ The project is built using following versions of softwares:
122128
```
123129
**Note - Always use `localhost:8000` instead of `127.0.0.1:8000` if you don't want access blocked from google during development**
124130

131+
# Contributing for Quiz Data
132+
1. Setup the project locally
133+
2. Make sure you have run following commands as mentioned in above steps.
134+
135+
```bash
136+
python manage.py createsuperuser
137+
python manage.py loaddata data/*
138+
```
139+
140+
3. Goto `localhost:8000/admin` and login using your **superuser** credentials.
141+
4. Add your Topics and Questions in the `Topics` & `Questions` models under the `Quiz` tab.
142+
5. Open the terminal and run
143+
```bash
144+
python manage.py dump_quiz
145+
```
146+
147+
125148
## Running Quality Checks
126149

127150
1. Format the Code

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ A platform for learning about AI/ML models and algorithms from theoretical to ex
2222
- [ ] Quiz
2323
- [ ] Documentation
2424

25-
## Contribution
25+
## Contribution & Setup Locally
2626
- For guidelines on how to contribute to this project, check out [Contribution Guidelines](./CONTRIBUTING.md).

0 commit comments

Comments
 (0)