-
Notifications
You must be signed in to change notification settings - Fork 1
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
1 parent
941377e
commit 1ecaafd
Showing
4 changed files
with
48 additions
and
5 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 |
---|---|---|
@@ -1,3 +1,4 @@ | ||
include README.md | ||
include VERSION | ||
recursive-include algobowl/public * | ||
include algobowl/public/favicon.ico | ||
|
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 |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# AlgoBOWL | ||
|
||
AlgoBOWL is a group project for algorithms courses. Students compete to create | ||
heuristics to an NP-hard problem. For more information, see the paper in | ||
[ITiCSE 2019](https://doi.org/10.1145/3304221.3319761). | ||
|
||
This is the AlgoBOWL web application, as well as associated tools (e.g., command | ||
line interface). | ||
|
||
## Getting Started | ||
|
||
The rest of this `README` assumes you're interested in hacking on the AlgoBOWL | ||
code, and want to install the web app locally. For other topics of interest, | ||
check out the `docs/` directory. | ||
|
||
You'll need a system running Linux and Python 3.8+. | ||
|
||
Create and activate a virtual environment to install in: | ||
|
||
```shellsession | ||
$ python3 -m venv venv | ||
$ . venv/bin/activate | ||
``` | ||
|
||
Next, install the app in editable mode:: | ||
|
||
```shellsession | ||
$ pip install -e ".[dev]" | ||
``` | ||
|
||
Next, copy the sample development config and setup the application:: | ||
|
||
```shellsession | ||
$ cp development.ini.sample development.ini | ||
$ gearbox setup-app | ||
``` | ||
|
||
Finally, you can serve the app:: | ||
|
||
```shellsession | ||
$ gearbox serve --reload --debug | ||
``` | ||
|
||
Have fun! |
This file was deleted.
Oops, something went wrong.
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