11# Let's Quiz
2+
23### [ letsquiz.pythonanywhere.com/] ( https://letsquiz.pythonanywhere.com/ ) [ ![ Website letsquiz.pythonanywhere.com] ( https://img.shields.io/website-up-down-green-red/http/letsquiz.pythonanywhere.com.svg )] ( http://letsquiz.pythonanywhere.com/ )
34
45This is an online quiz organizing website project, developed using Python's web framework Django.<br >
@@ -15,79 +16,82 @@ For front-end designing I have used Twitter's front-end library Bootstrap4.
1516
1617### Site access features:
1718
18- * User must be logged in to access the Quiz.
19- * For signup user is required to give * username * , * first name * , * last name * , * e -mail address * and * password * .
20- * For login the user will be required to enter * username * and * password * only.
19+ - User must be logged in to access the Quiz.
20+ - For signup user is required to give _ username _ , _ first name _ , _ last name _ , _ e -mail address _ and _ password _ .
21+ - For login the user will be required to enter _ username _ and _ password _ only.
2122
2223### Features of the quiz:
2324
24- * All questions are multiple choice question.
25- * Each question is displayed only once per user.
26- * Questions are displayed randomly for every user.
27- * If the user by-mistake presses refresh or go back to the previous page, there will be a new question for the user and the
25+ - All questions are multiple choice question.
26+ - Each question is displayed only once per user.
27+ - Questions are displayed randomly for every user.
28+ - If the user by-mistake presses refresh or go back to the previous page, there will be a new question for the user and the
2829 question he/she was on will be marked as attempted.
29- * A message will be displayed after every attempted question whether the answer was correct or incorrect.
30-
30+ - A message will be displayed after every attempted question whether the answer was correct or incorrect.
3131
3232### Leaderboard features:
3333
34- * Leaderboard is a shorted list according to the score obtained by the users.
35- * If two users are having same score, the user who has signed up earlier will have good ranking than the one who joined late.
36- * Leaderboard is open to all. No login required.
34+ - Leaderboard is a shorted list according to the score obtained by the users.
35+ - If two users are having same score, the user who has signed up earlier will have good ranking than the one who joined late.
36+ - Leaderboard is open to all. No login required.
3737
3838### Administrative features:
3939
40- * Only admin can add questions.
41- * Admin can add questions and modify them until they are not marked as * Has been published?*
42- * Once a question has been published, it can neither be modified nor can be accessed. Admin can only see a list of questions.
43- * Admin can search questions by question text or choice text.
44- * Admin can filter questions based on whether the questions have been published or not.
45-
40+ - Only admin can add questions.
41+ - Admin can add questions and modify them until they are not marked as _ Has been published?_
42+ - Once a question has been published, it can neither be modified nor can be accessed. Admin can only see a list of questions.
43+ - Admin can search questions by question text or choice text.
44+ - Admin can filter questions based on whether the questions have been published or not.
4645
4746## Getting started with development
47+
4848Dependencies:
49+
4950- Python 3.6.x
5051- Django 1.11.x
5152- Ubuntu 17.04 or later or Linux Mint 18.2 or later
5253
5354### 1. Clone this repository
55+
5456``` bash
5557git clone https://github.com/akashgiricse/lets-quiz.git
5658cd lets_quiz
5759```
5860
59- ### 2. Install the [ virtualenvwrapper] ( https://virtualenvwrapper.readthedocs.io/ )
60- Follow [ instructions on official documentation page] ( https://virtualenvwrapper.readthedocs.io/en/latest/install.html ) .
61+ ### 2. Install [ Pipenv] ( https://pipenv.pypa.io/en/latest/ )
6162
6263### 3. Create the virtualenv
64+
6365``` bash
6466# # run following command from `lets_quiz` directory
65- mkvirtualenv lets_quiz -a " $( pwd ) " -p python3.6
67+ pipenv shell
6668```
6769
6870### 4. Install python packages
71+
6972``` bash
70- # # Activate the virtualenv which you created on the last step
71- workon lets_quiz
72- cd ..
7373pip install -r requirements.txt
7474```
7575
7676### 5. Setup the database
77- * TODO - Add instructions for this when I start using MySQL database.*
77+
78+ _ TODO - Add instructions for this when I start using MySQL database._
7879
7980### 6. Run database migrations
81+
8082``` bash
8183cd lets_quiz
8284python manage.py migrate
8385```
8486
8587### 7. Create superuser
88+
8689``` bash
8790python manage.py createsuperuser
8891```
8992
9093### 8. Run development server
94+
9195``` bash
9296python manage.py runserver
9397```
@@ -99,14 +103,15 @@ python manage.py runserver
99103
100104## Contributors
101105
102- * [ Akash Giri] ( https://github.com/akashgiricse )
106+ - [ Akash Giri] ( https://github.com/akashgiricse )
103107
104108## Support
105109
106- * If you are having issues, please let me know.<gr >
107- I have a mailing list located at:
[email protected] 110+ - If you are having issues, please let me know.<gr >
111+ I have a mailing list located at:
[email protected] 108112
109113## License
114+
110115MIT License
111116
112117Copyright (c) 2018 Akash Giri.
0 commit comments