Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/copier-jinja
Copier Template - Simple Flask/Jinja Starter | AppSeed
https://github.com/app-generator/copier-jinja
appseed copier-template flask
Last synced: 5 days ago
JSON representation
Copier Template - Simple Flask/Jinja Starter | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/copier-jinja
- Owner: app-generator
- License: other
- Created: 2021-01-24T05:06:32.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-24T10:57:24.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T04:43:39.874Z (27 days ago)
- Topics: appseed, copier-template, flask
- Language: CSS
- Homepage: https://copier-jinja.appseed-srv1.com
- Size: 7.63 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - app-generator/copier-jinja - Copier Template - Simple Flask/Jinja Starter | AppSeed (CSS)
README
# Jinja Copier Template
Template project - provided by AppSeed.
> Features:
- Generator: [Copier](https://github.com/copier-org/copier/)
- UI Kit: **Pixel Lite** (Free Version) by **Themesberg**
- Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
- Deployment scripts: Docker, Gunicorn/Nginx, HEROKU
- Support via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).
> Links
- [LIVE Demo](https://copier-jinja.appseed-srv1.com) - starter in action
- More [Jinja Templates](https://appseed.us/jinja-template) provided by AppSeed
## How to use it
**Install copier**
```bash
$ pip install copier
```
**Clone the template**
```bash
$ # Generate the template - Syntax
$ # copier
$
$ copier https://github.com/app-generator/copier-jinja.git
```
During the process the user should provide:
- Project Name: used in the master pages (title element)
- Project Author: used in the `index.html`
## Generated Structure
The project has a simple structure, represented as bellow:
```bash
< PROJECT ROOT >
|
|-- app/__init__.py
|-- app/
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/
| | |
| | |-- includes/ # Page chunks, components
| | | |
| | | |-- navigation.html # Top bar
| | | |-- sidebar.html # Left sidebar
| | | |-- scripts.html # JS scripts common to all pages
| | | |-- footer.html # The common footer
| | |
| | |-- layouts/ # App Layouts (the master pages)
| | | |
| | | |-- base.html # Used by common pages like index, UI
| | | |-- base-fullscreen.html # Used by auth pages (login, register)
| | |
| | index.html # The default page
| | login.html # Auth Login Page
| | register.html # Auth Registration Page
| | page-404.html # Error 404 page (page not found)
| | page-500.html # Error 500 page (server error)
| | *.html # All other pages provided by the UI Kit
|
|-- requirements.txt
|
|-- run.py
|
|-- ************************************************************************
```
## Deployment
The project comes with a basic configuration for [Docker](https://www.docker.com/), [HEROKU](https://www.heroku.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
### [Docker](https://www.docker.com/) execution
---
The steps to start the template using Docker:
> Get the code
```bash
$ # CD into the root of the project
$ cd < ROOT_DIRECTORY >
```
> Start the app in Docker
```bash
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
```
Visit `http://localhost:5005` in your browser. The app should be up & running.
### [Heroku](https://www.heroku.com/)
---
Steps to deploy on **Heroku**
- [Create a FREE account](https://signup.heroku.com/) on Heroku platform
- [Install the Heroku CLI](https://devcenter.heroku.com/articles/getting-started-with-python#set-up) that match your OS: Mac, Unix or Windows
- Open a terminal window and authenticate via `heroku login` command
- Clone the sources and push the project for LIVE deployment
```bash
$ # CD into the root of the project
$ cd < ROOT_DIRECTORY >
$
$ # Check Heroku CLI is installed
$ heroku -v
heroku/7.25.0 win32-x64 node-v12.13.0 # <-- All good
$
$ # Check Heroku CLI is installed
$ heroku login
$ # this commaond will open a browser window - click the login button (in browser)
$
$ # Create the Heroku project
$ heroku create
$
$ # Trigger the LIVE deploy
$ git push heroku master
$
$ # Open the LIVE app in browser
$ heroku open
```
### [Gunicorn](https://gunicorn.org/)
---
Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.
> Install using pip
```bash
$ pip install gunicorn
```
> Start the app using gunicorn binary
```bash
$ gunicorn --bind 0.0.0.0:8001 run:app
Serving on http://localhost:8001
```
Visit `http://localhost:8001` in your browser. The app should be up & running.
### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)
---
Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.
> Install using pip
```bash
$ pip install waitress
```
> Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)
```bash
$ waitress-serve --port=8001 run:app
Serving on http://localhost:8001
```
Visit `http://localhost:8001` in your browser. The app should be up & running.
## Credits & Links
- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The official website
---
Jinja Copier Template - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).