Skip to content

PR to add readme information #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Magicking wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

PR to add readme information #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,37 @@ pinned: false
license: cc-by-nc-nd-4.0
---

# Description

This is an assignation application that allows user to generate assignation for EthCC volunteers.

# Setup

Create a virtual environement and activates it

`$> python -m venv venv && source venv/bin/activate`

Install dependencies using pip

`$(venv)> pip install -r requirements.txt`

# Usages


## Environment variables

- TEAMS
TBD

- ORGANIZATION
TBD

- SERVICES
TBD

- VOLUNTEERS
TBD

## Tuning

See config/inference.py
2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
python-dotenv
pandas
numpy
request
requests