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
Showing
1 changed file
with
7 additions
and
74 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,79 +1,12 @@ | ||
## Python Flask Skeleton for Google App Engine | ||
Change into directory, and run: | ||
|
||
A skeleton for building Python applications on Google App Engine with the | ||
[Flask micro framework](http://flask.pocoo.org). | ||
`virtualenv venv` | ||
`. venv/bin/activate` | ||
|
||
See our other [Google Cloud Platform github | ||
repos](https://github.com/GoogleCloudPlatform) for sample applications and | ||
scaffolding for other python frameworks and use cases. | ||
Then: | ||
|
||
## Run Locally | ||
1. Install the [App Engine Python SDK](https://developers.google.com/appengine/downloads). | ||
See the README file for directions. You'll need python 2.7 and [pip 1.4 or later](http://www.pip-installer.org/en/latest/installing.html) installed too. | ||
`pip install -r requirements.txt` to install python packages | ||
|
||
2. Clone this repo with | ||
Run: | ||
|
||
``` | ||
git clone https://github.com/GoogleCloudPlatform/appengine-python-flask-skeleton.git | ||
``` | ||
3. Install dependencies in the project's lib directory. | ||
Note: App Engine can only import libraries from inside your project directory. | ||
|
||
``` | ||
cd appengine-python-flask-skeleton | ||
pip install -r requirements.txt -t lib | ||
``` | ||
4. Run this project locally from the command line: | ||
|
||
``` | ||
dev_appserver.py . | ||
``` | ||
|
||
Visit the application [http://localhost:8080](http://localhost:8080) | ||
|
||
See [the development server documentation](https://developers.google.com/appengine/docs/python/tools/devserver) | ||
for options when running dev_appserver. | ||
|
||
## Deploy | ||
To deploy the application: | ||
|
||
1. Use the [Admin Console](https://appengine.google.com) to create a | ||
project/app id. (App id and project id are identical) | ||
1. [Deploy the | ||
application](https://developers.google.com/appengine/docs/python/tools/uploadinganapp) with | ||
|
||
``` | ||
appcfg.py -A <your-project-id> --oauth2 update . | ||
``` | ||
1. Congratulations! Your application is now live at your-app-id.appspot.com | ||
|
||
## Next Steps | ||
This skeleton includes `TODO` markers to help you find basic areas you will want | ||
to customize. | ||
|
||
### Relational Databases and Datastore | ||
To add persistence to your models, use | ||
[NDB](https://developers.google.com/appengine/docs/python/ndb/) for | ||
scale. Consider | ||
[CloudSQL](https://developers.google.com/appengine/docs/python/cloud-sql) | ||
if you need a relational database. | ||
|
||
### Installing Libraries | ||
See the [Third party | ||
libraries](https://developers.google.com/appengine/docs/python/tools/libraries27) | ||
page for libraries that are already included in the SDK. To include SDK | ||
libraries, add them in your app.yaml file. Other than libraries included in | ||
the SDK, only pure python libraries may be added to an App Engine project. | ||
|
||
### Feedback | ||
Star this repo if you found it useful. Use the github issue tracker to give | ||
feedback on this repo. | ||
|
||
## Contributing changes | ||
See [CONTRIB.md](CONTRIB.md) | ||
|
||
## Licensing | ||
See [LICENSE](LICENSE) | ||
|
||
## Author | ||
Logan Henriquez and Johan Euphrosine | ||
`python main.py` to run at `localhost:5000` |