You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,12 +56,14 @@ To talk to DynamoDB, we've put some calls made using the AWS `boto3` library beh
56
56
57
57
So you want to clone or fork this thing and get it running yourself? Have at it. The steps below assume you:
58
58
59
-
* have a **Python 3.5+** installation on your machine
59
+
* have a **Python 3.6+** installation on your machine
60
60
* can run `python` and `pip` commands (or whatever aliases you've configured for for Python 3) from the command line
61
61
* have `git` installed and can run some basic `git` commands
62
62
* have `node`, `npm`, and `gulp` installed, for running tasks. This isn't strictly required for development, unless you plan to work with the client side `javascript` or `css`.
63
63
64
-
This was built with Python 3.5 on Windows 10. Since Python on Windows can sometimes be a pain, we recommend pairing the official Python 3 installer from [python.org](https://www.python.org/) with a Windows console emulator like [**Cmder** w/Git-for-Windows](http://cmder.net/)
64
+
This was built with Python 3.6 on Windows 10. Since Python on Windows can sometimes be a pain, we recommend pairing the official Python 3 installer from [python.org](https://www.python.org/) with a Windows console emulator like [**Cmder** w/Git-for-Windows](http://cmder.net/)
65
+
66
+
To work with notebooks in the `/notebooks` folder, you'll also need to have Jupyter installed.
65
67
66
68
### 1. Clone this repository
67
69
@@ -109,23 +111,25 @@ Navigate to [http://localhost:5000](http://localhost:5000) to see the site.
109
111
Skip Step 5a. Run:
110
112
111
113
```
112
-
$ gulp
114
+
$ npm run dev
113
115
```
114
116
115
117
This will work some magic on the files in the `src` folder, put them where the Flask application expects them to be, fire up `application.py`, watches for changes to `js` and `css` files in `src`, and starts `browser-sync`. It should automatically open the browser for you; if not, navigate to [http://localhost:3000](http://localhost:3000) to see the site.
116
118
117
119
It doesn't fire up the database (Step 4), so make sure that's running in the background (in another command line console) before you start.
118
120
119
-
##Tests
121
+
### 6. Building the client side code for production
120
122
121
-
Some basic Python unit tests are in the `tests` folder (`test_*.py`). Coverage is low at the moment; it's a WIP.
123
+
```
124
+
$ npm run build
125
+
```
122
126
123
-
## Deployment
127
+
This will create minified and uglified versions of the javascript and CSS files, along with sourcemaps.
124
128
125
-
There are many ways to deploy this application. [PythonAnywhere](https://www.pythonanywhere.com/) provides a great place for deploying Flask applications like this. This one could also easily by deployed to AWS Elastic Beanstalk.
129
+
## Tests
126
130
127
-
### Deployment to AWS Elastic Beanstalk
131
+
Some basic Python unit tests are in the `tests` folder (`test_*.py`). Coverage is low at the moment; it's a WIP.
128
132
129
-
Follow [this](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/create-deploy-python-flask.html) guide for deployment.
133
+
## Deployment
130
134
131
-
As of this writing, AWS Elastic Beanstalk supports Python 3.4.
135
+
There are many ways to deploy this application. Currently we host in on [PythonAnywhere](https://www.pythonanywhere.com/). Ping [@gassc](https://github.com/gassc) if you're interested in helping run the deployment.
0 commit comments