Flask-GAE

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 19 Open GitHub ↗

This is my Flask Google App Engine template.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#Flask on Google App Engine Template
[![Build Status](https://secure.travis-ci.org/kelp404/Flask-GAE.png?branch=master)](http://travis-ci.org/kelp404/Flask-GAE)
[![devDependency Status](https://david-dm.org/kelp404/Flask-GAE/dev-status.png?branch=master)](https://david-dm.org/kelp404/Flask-GAE#info=devDependencies)

[MIT License](http://www.opensource.org/licenses/mit-license.php)

```
   ______   __         ______     ______     __  __
  /\  ___\ /\ \       /\  __ \   /\  ___\   /\ \/ /
  \ \  __\ \ \ \____  \ \  __ \  \ \___  \  \ \  _"-.
   \ \_\    \ \_____\  \ \_\ \_\  \/\_____\  \ \_\ \_\
    \/_/     \/_____/   \/_/\/_/   \/_____/   \/_/\/_/
```

This project is my <a href="https://developers.google.com/appengine/" target="_blank">GAE</a> project template.  
And the example application uses <a href="http://www.whatwg.org/specs/web-apps/current-work/#history-0" target="_blank">History</a> to link pages, so that all hyperlinks are ajax.

##Frameworks
+ Flask 0.10.1
+ Jinja 2.7.1
+ Werkzeug 0.9.3
+ Bootstrap 2.3.2
+ jQuery 2.1.0
+ Google App Engine Launcher 1.8.9

##How to use?
```bash
$ git clone --recursive git://github.com/kelp404/Flask-GAE.git
```

./
```
├─ application       # Web application code
├─ flask             # Flask framework
├─ jinja2            # Jinja framework
├─ tests             # Unit tests
├─ werkzeug          # Werkzeug framework
├─ app.yaml          # GAE app config
├─ backends.yaml     # GAE backends config
├─ cron_jobs.py      # Cron jobs code
├─ cron.yaml         # GAE Cron jobs config
├─ itsdangerous.py
└─ index.yaml        # GAE datastore indexes config
```

./application/
```
├─ data_models       # Datastore data model
├─ handlers          # Web handlers (MVC's controller)
├─ models            # Other models
├─ services          # All business logic here (MVC's model)
├─ static
│  ├─ coffeescript   # CoffeeScript
│  ├─ css
│  ├─ font
│  ├─ icon
│  ├─ img
│  ├─ javascript
│  ├─ binding.py     # JavaScript, CSS binder
│  └─ robots.txt
├─ templates         # Jinja templates (MVC's view)
├─ utilities         # Web application's shared utilities(helpers)
├─ __init__.py
├─ config.py         # Application config
└─ routes.py         # Web application's routers
```

##Example application
Board: https://flask-gae-kelp.appspot.com/posts  
Chat: https://flask-gae-kelp.appspot.com/chat

##Deploy with <a href="https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Python" target="_blank">appcfg.py</a>
You should create a GAE account.  
https://appengine.google.com  
  
###update `app.yaml`
```Python
application: flask-gae-kelp
'flask-gae-kelp' should replace to your Application Identifier.
```

###deploy project
**deploy**
```bash
# Flask-GAE is the folder name of the project
$ appcfg.py update Flask-GAE/
```
**deploy backends**
```bash
$ appcfg.py backends Flask-GAE/ update
```

###deleting unused indexes
```bash
$ appcfg.py vacuum_indexes Flask-GAE/
# https://developers.google.com/appengine/docs/python/tools/uploadinganapp?hl=en#Deleting_Unused_Indexes
```

##Development
```bash
# install node modules
$ npm install
```
```bash
# run the local server and the file watcher to compile CoffeeScript
$ grunt dev
```

###[Closure Compiler](https://code.google.com/p/closure-compiler/)
You could download compiler form [Google Code](https://code.google.com/p/closure-compiler/wiki/BinaryDownloads?tm=2).

**[File Watchers][File Watchers]:**

Watcher Settings  |  value 
:---------:|:---------:
Program | /Users/Kelp/tool/closure-compiler/compiler.jar
Arguments | --compilation_level SIMPLE_OPTIMIZATIONS --js $FileName$
Output paths | $FileNameWithoutExtension$.min.js<br/>(Create output file from stdout)
---

##Unittest
Before test, you should run GAE local server, and clear datastore, text search, and update url in function 'setUp()'.
```Python
class TestFunctions(unittest.TestCase):
    def setUp(self):
        self.url = 'http://localhost:8081'
        self.email = 'kelp@phate.org'
        self.cookies = { 'dev_appserver_login': "kelp@phate.org:True:111325016121394242422" }
```
clear datastore & text search:
```
--clear_datastore=yes --clear_search_indexes=yes
```
```bash
$ cd Flask-GAE
$ python tests
```
Python unit test reference: <a href="http://docs.python.org/2/library/unittest.html" target="_blank">http://docs.python.org/2/library/unittest.html</a>

##References
+ <a href="https://developers.google.com/appengine/downloads" target="_blank">Google App Engine SDK</a>
+ <a href="https://developers.google.com/appengine/docs/python/overview" target="_blank">Google App Engine Python Overview</a>
+ <a href="https://github.com/mitsuhiko/flask" target="_blank">Flask on GitHub</a>
(<a href="http://flask.pocoo.org/" target="_blank">document</a>)
+ <a href="https://github.com/mitsuhiko/jinja2" target="_blank">Jinja2 on GitHub</a>
(<a href="http://jinja.pocoo.org/" target="_blank">document</a>)
+ <a href="https://github.com/mitsuhiko/werkzeug" target="_blank">Werkzeug on GitHub</a>
(<a href="http://werkzeug.pocoo.org/" target="_blank">document</a>)
+ <a href="https://github.com/mitsuhiko/itsdangerous" target="_blank">itsdangerous on GitHub</a>
+ <a href="http://twitter.github.com/bootstrap/" target="_blank">Bootstrap</a>
+ <a href="https://github.com/jashkenas/coffee-script" target="_blank">CoffeeScript on GitHub</a>
(<a href="http://coffeescript.org/" target="_blank">document</a>)
+ <a href="http://jquery.com/" target="_blank">jQuery</a>
+ <a href="https://github.com/kennethreitz/requests" target="_blank">Requests on GitHub</a>
+ <a href="http://www.crummy.com/software/BeautifulSoup/bs4/doc/" target="_blank">Beautiful Soup</a>
+ <a href="https://github.com/chriseppstein/compass" target="_blank">Compass on GitHub</a>

Flask-GAE

Today's picks

Was this content helpful?

Recent Feedback

Flask-GAE

Today's picks

Was this content helpful?

Recent Feedback

Download README