Skip to content

Commit ecdde69

Browse files
author
Brandon Istenes
committed
Add README
1 parent 60d5832 commit ecdde69

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# GAE Flask Web Base
2+
3+
## Getting Started
4+
5+
Run `./setup.sh`. It'll install some npm dependencies, create a Python
6+
virtualenv, and compile assets.
7+
8+
Run `./dev_server.sh start` to start the dev server at `localhost:8080`.
9+
10+
`./run_tests.sh` does what it says on the tin.
11+
12+
13+
## Environments
14+
15+
There are three environments: TEST, DEV, and PROD. Since GAE doesn't
16+
support environment variables, you switch between them by symlinking
17+
`src/application/env_conf.py` to the file in `src/application/config/`
18+
that you'd like.
19+
20+
21+
## Assets
22+
23+
Libs are managed with bower. Put your own JS and CSS in
24+
`src/application/assets/`. These files get compiled by executing
25+
`src/assets.py`, putting artifacts in `src/application/static/`.
26+
27+
28+
## Credit
29+
30+
Made with love by the eng team at [Socos LLC](http://www.socoslearning.com)
31+

0 commit comments

Comments
 (0)