https://github.com/janmarkuslanger/clean-flask
Clean flask boilerplate with sqlalchemy, webpack, eslint, babel, scss and more.
https://github.com/janmarkuslanger/clean-flask
boilerplate flask flask-boilerplate scss sqlalchemy webpack
Last synced: 8 months ago
JSON representation
Clean flask boilerplate with sqlalchemy, webpack, eslint, babel, scss and more.
- Host: GitHub
- URL: https://github.com/janmarkuslanger/clean-flask
- Owner: janmarkuslanger
- Created: 2019-09-29T16:40:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-01T12:51:18.000Z (over 5 years ago)
- Last Synced: 2025-02-01T01:33:02.122Z (over 1 year ago)
- Topics: boilerplate, flask, flask-boilerplate, scss, sqlalchemy, webpack
- Language: Python
- Homepage:
- Size: 421 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# clean-flask
Kickstart your next flask project with clean-flask. Clean-Flask is a template which bundles a few vital components when it comes to modern web applications.
## What do you get
**Flask**
Flask is a super lightweight framework for web servers.
**SQLAlchemy**
SQLAlchemy is an Object-Relational-Mapper that supports SQLite, MySql, and much more.
**webpack**
Webpack is a bundler for your stylesheets and javascript. It comes with babel and some other neat packages like an autoprefixer for your scss files.
**scss**
SCSS is a super cool preprocessor for your stylesheets.
**eslint**
Lints your javascript files.
**login**
This template comes with a simple, not safe login.
## Get started
Clone or download this repository. Start your terminal and move into the root of this repository.
**Backend**
1. Create a virtual env `python3 -m venv venv`
2. Install dependencies `pip3 install -r requirements.txt`
3. Create DB `python3 db_setup.py`
4. Create demo user `python3 demo_data.py`
5. Run server `python3 run.py`
**Frontend**
1. Install packages `npm i`
2. Start bundler `npm run watch`
## Commands
- `npm run lint-js` - Lints your javascript files via eslint
- `npm run watch` - Start webpack and watch files
- `npm run build` - Build your assets files once
- `flake8 app` - Lint your python files via flake8