Skip to content

Commit 2d40e1f

Browse files
cleanup and update readme
1 parent 3e6a3de commit 2d40e1f

5 files changed

Lines changed: 22 additions & 1058 deletions

File tree

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
1-
# chrono des vignes
2-
chrono des vignes is a web app made in python and the [Flask](https://pypi.org/project/Flask/) framwork for the back-end and the html, javascript for the front-end
3-
4-
## build the app
5-
to build the app you need to
6-
- rebuild the .venv from the requirement.txt
7-
- open a terminal with the virtual environment
8-
- launch the server with
1+
# Chrono des Vignes
2+
Chrono des Vignes is a timing system for sports events. It allows event organizers to manage events, editions, courses, and runners, and track times and results.
3+
4+
## Features
5+
* Event management: create and manage events, editions, and courses
6+
* Runner management: track runner information and results
7+
* Time tracking: track times and results for each runner
8+
* Multilingual support: supports French, English and German languages
9+
10+
## Getting Started
11+
To get started with Chrono des Vignes, please follow these steps:
12+
13+
1. Rebuild the virtual environment from the `requirements.txt` file
14+
2. Open a terminal with the virtual environment
15+
3. Launch the server with the following command:
916
```shell
10-
$env:FLASK_DEBUG = 1;$env:FLASK_APP = "chrono_des_vignes";flask run --extra-files flask-app/templates/:flask_app/translations/```
17+
$env:FLASK_DEBUG = 1;$env:FLASK_APP = "chrono_des_vignes";flask run --extra-files flask-app/templates/:flask_app/translations/```
18+
19+
## Live Demo
20+
Experience Chrono des Vignes in action by visiting our [Deployed version](https://chronodesvignes.eu.pythonanywhere.com/).
21+
22+
## Documentation
23+
For detailed usage instructions, please refer to our [Documentation](chrono_des_vignes/templates/doc).

create_db.py

Lines changed: 0 additions & 23 deletions
This file was deleted.

db_setter.py

Lines changed: 0 additions & 69 deletions
This file was deleted.

requirements.txt

1.13 KB
Binary file not shown.

0 commit comments

Comments
 (0)