-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
38 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -128,4 +128,5 @@ dmypy.json | |
# Pyre type checker | ||
.pyre/ | ||
db.sqlite3 | ||
.vscode/ | ||
.vscode/ | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,48 @@ | ||
# django-euro-vote | ||
A Django Web App that let's friends and family vote in a group for the Eurovision Song Contest. | ||
# Eurovote | ||
|
||
Vote out of 10 and find out the group favourite | ||
![results](results.png) | ||
![Build and Deploy App](https://github.com/ddunne6/eurovote/actions/workflows/main_eurovote.yml/badge.svg) | ||
|
||
A voting app for the Eurovision Song Contest. Host the Django Web App to let your friends and family rate each finalist out of 10. | ||
|
||
## Installation | ||
|
||
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the dependencies. | ||
|
||
## How to run | ||
Install requirements.txt | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
Run the web app | ||
|
||
|
||
Create a *'.env'* file with the following keys: | ||
|
||
``` | ||
python django_euro_vote/manage.py runserver | ||
DJANGO_SECRET_KEY=... | ||
DEBUG=true/false | ||
DEVELOPMENT=true/false | ||
``` | ||
Open the website in a web browser | ||
|
||
Migrate the local SQLite database. | ||
``` | ||
http://localhost:8000/ | ||
python manage.py migrate | ||
``` | ||
Login using superuser or make an acccount | ||
Run the web application | ||
``` | ||
username: admin | ||
password: admin | ||
python manage.py runserver | ||
``` | ||
Add the countries and running orders, run the server, share the link, get voting! | ||
|
||
## Additional Features | ||
Prevent additional users from signing up by opening http://localhost:8000/admin > settings > Setting object (1) > untick the box | ||
## Features | ||
|
||
- User authentication system (login/logout/register) | ||
- Set countries and their running order | ||
- Rate each country out of 10 | ||
- View other users' ratings | ||
|
||
![alt text](readme_resources/my_ratings_screenshot.png) | ||
|
||
## Contributing | ||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. | ||
|
||
Please make sure to update tests as appropriate. | ||
|
||
## License | ||
[MIT](https://choosealicense.com/licenses/mit/) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.