https://github.com/Sumukh/ignite-pdf-watermarker
https://github.com/Sumukh/ignite-pdf-watermarker
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Sumukh/ignite-pdf-watermarker
- Owner: Sumukh
- License: other
- Created: 2021-11-28T21:28:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T09:04:24.000Z (about 2 years ago)
- Last Synced: 2024-11-08T07:12:15.826Z (5 months ago)
- Language: CSS
- Size: 6.67 MB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - Sumukh/ignite-pdf-watermarker - (CSS)
README
## Sample SaaS Boilerplate for Flask
This is a demo app for FlaskCon 2021, based off of the [Flask Ignite](https://github.com/sumukh/ignite) boilerplate.
## Setup
Usage of Python 3 is required. It can be installed [on Python.org](https://www.python.org/downloads/)
```
# Optional but recommended:
python3 -m venv env; source env/bin/activate
pip install -r requirements.txt
./manage.py server # or `FLASK_APP=manage FLASK_ENV=development flask run`
```
## Running
```
# Development
# If using a virtual env: source env/bin/activate
./manage.py resetdb
# ^ to seed data
# Go to localhost:5000 in a browser and click on Login
# Login with the following credentials "[email protected]", "test
# Production documentation in the repository.
```
## Testing
Github Actions is configured to run tests and produce code coverage metrics.
To run tests locally, try this command:
```
APPNAME_ENV=test ./manage.py test --coverage
```
### Local Secrets
To configure OAuth login and Stripe billing in development, you will need to set some environment variables. See `.env.local.sample` for an example.
```bash
cp .env.local.sample .env.local
# Edit .env.local with your Stripe & Google test keys
source .env.local
flask run
```
You may also want to change some of the constants in `appname.constants`
## Deployment
Ignite is not tied to a specific platform for deployment, but it works well on [Heroku](http://heroku.com) and [Dokku](http://dokku.viewdocs.io/dokku/) with minimal configuration.
It is also designed to work well on other cloud providers such as AWS, Google Cloud, and DigitalOcean.
Documentation is currently provided for installations on Dokku.
## License
You may use this project for non commericial projects.
For more detailed license information see LICENSE.md
## Credits
Design elements from [tabler](https://github.com/tabler/tabler) & Bootstrap 4.
Built off of [Flask Foundation](https://jackstouffer.github.io/Flask-Foundation/) and the [bootstrapy project](https://github.com/kirang89/bootstrapy)
### Extra Reading
Only building out an API using Flask?
* Use [create-flask-api](https://github.com/Sumukh/create-flask-api)
**Course: [Fullstack Flask: Build a SaaS using Python and Flask](https://www.newline.co/fullstack-flask/)**
Best practices List:
* [Larger Applications With Flask](http://flask.pocoo.org/docs/patterns/packages/).
* [Creating Websites With Flask](http://maximebf.com/blog/2012/10/building-websites-in-python-with-flask/)
* [Getting Bigger With Flask](http://maximebf.com/blog/2012/11/getting-bigger-with-flask/)
* [Miguel Grinberg's Blog](https://blog.miguelgrinberg.com/category/Python)