Skip to content

Commit de98335

Browse files
authored
Update readme for other devs. (#20)
* Added Getting Started section.
1 parent 45ffff9 commit de98335

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# clarence
22
Herein lies the code that powers [checkmymate.co](http://checkmymate.co/), a website that enables you to see how to beat your friends at chess.
33

4-
## About
5-
This app is brought to you in part by flask.
4+
## Getting Started
5+
So you want to work on checkmymate? Great! To develop and test locally, all you need to do is clone the project, create a virtual environment, and launch the flask app:
6+
7+
### Clone the project
8+
Run the following command in your terminal:
9+
`git clone https://github.com/bfeif/clarence.git`
10+
11+
### Create a virtual environment
12+
This project encourages the built-in python `venv` tool for managing virtual environments. To create a virtual environment for this project, run the following commands in terminal:
13+
1. `cd path/to/clarence` - Go to the root of the project directory.
14+
2. `python3 -m venv .venv` - Create a virtual environment.
15+
3. `source .venv/bin/activate` - Activate the virtual environment.
16+
4. `pip install -r requirements.txt` - Install all necessary packages to the virtual environment.
17+
18+
### Launch the flask app
19+
1. With the virtual environment activated, launch the flask app with `flask run`.
20+
2. A bunch of text will pop up in your terminal, one of which will say something like `Running on http://127.0.0.1:5000/`. Copy and paste this url to your web-browser.
21+
3. Great! Now you have the application running locally, and you should be able to see the changes you make in the code automatically update in your browser!

0 commit comments

Comments
 (0)