SaaS-in-a-Flask - GitLite

KO | EN

gitlite — search

#open-source #gpt #hacktoberfest #openai #video #tailwindcss #deep-learning #svg #javascript #pdf

SaaS-in-a-Flask

(★ 10)

A SaaS starter boilerplate for Flask Applications

File Explorer

ZIP Download

- - Codecov.yaml
  - Docker-Build.yaml
  - Flask-Tests.yaml
- - __init__.py
  - app_forms.py
- - _formhelpers.html
  - base.html
  - contact.html
  - dashboard.html
  - flash_messages.html
  - index.html
  - message.html
- - __init__.py
  - conftest.py
  - test_admin.py
  - test_cli.py
  - test_fastapi.py
  - test_forms.py
  - test_models.py
  - test_views.py
- - __init__.py
  - admin.py
  - auth.py
  - error_pages.py
  - main.py
- __init__.py
- apis.py
- config.py
- config_dev.py
- misc_func.py
- models.py
- conf.py
- index.rst
- make.bat
- Makefile
- - 02e90d95b9e8_.py
- alembic.ini
- env.py
- README
- script.py.mako
- - admin-dashboard.png
  - dashboard.png
  - landing-1.png
  - landing-2.png
  - landing-3.png
  - login.png
  - register.png
.deepsource.toml
.gitignore
api.py
Dockerfile
LICENSE
Makefile
Pipfile
Pipfile.lock
Procfile
README.md
requirements.txt
simple-requirements.txt

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`pip3`

View Details ▼

This command is an alias of `pip`.

tldr pip

View documentation for the original command:

🔍

`pipenv`

View Details ▼

Simple and unified Python development workflow.
Manage packages and the virtual environment for a project.

pipenv

Create a new project:

pipenv --three

Create a new project using Python 3:

pipenv install {{package}}

Install a package:

🔍

`python`

View Details ▼

Python language interpreter.

python

Start a REPL (interactive shell):

python {{path/to/file.py}}

Execute a specific Python file:

python -i {{path/to/file.py}}

Execute a specific Python file and start a REPL:

🔍

`python3`

View Details ▼

This command is an alias of `python`.

tldr python

View documentation for the original command:

# Project Badges

codecov Visit
Flask Tests Visit
DeepSource Visit

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

In the wise words of @alectrocute:

> I've noticed SaaS bootstraps/boilerplates being sold upwards of $1,000 per year and I think that's fucking ridiculous.

## Features / To-Do

- [x] **Landing Page:** Written in Bootstrap 5, compatible with [Bootswatch Themes](https://bootswatch.com) (Just replace bootstrap.min.css)
- [x] **Database Management:** Using CLI or Superuser view
	- [x] **Migration:** Using Flask-Migrate
- **Authentication:** Using Flask-Login 
	- [x] Sign Up
	- [x] Sign In
	- [x] **OAuth2:** Using Authlib
	- [ ] LDAP
	- [ ] Forgot Password
	- [x] Confirm Email
	- [x] **Password Hashing:** Using Bcrypt (Flask-Bcrypt)
- [x] **Form Handling:** With Flask-WTF using WTForms
- [x] Dashboard
- [x] GitHub Workflows
- [x] **Admin Pages:** Using Flask-Admin
- [ ] Role Support
- [ ] Team Management
- Error Handling
	- [x] Sentry Support
	- [x] Error Code Handling
- [ ] Async AJAX Calls 
- [x] **Tests:** Using PyTest
- [x] **Code Coverage:** Using CodeCov
- [ ] Delayed Jobs
- [ ] Logging
- [x] FastAPI Support
- Billing Handling
	- [ ] Stripe
- [ ] GDPR Compliance / Data Export
- [x] Docker Images
- [x] **Automatic Deployments:** Using Heroku [Sample Deployment](https://saas-in-a-flask.herokuapp.com)

## Screenshots

### Landing

![Landing-1](https://raw.githubusercontent.com/navanchauhan/SaaS-in-a-Flask/master/misc/screenshots/landing-1.png)

![Landing Page on Mobile](https://raw.githubusercontent.com/navanchauhan/SaaS-in-a-Flask/master/misc/screenshots/landing-2.png)

![Landing Page Features on Mobile](https://raw.githubusercontent.com/navanchauhan/SaaS-in-a-Flask/master/misc/screenshots/landing-3.png)

![Login Page](https://raw.githubusercontent.com/navanchauhan/SaaS-in-a-Flask/master/misc/screenshots/login.png)

![Sign Up Page](https://raw.githubusercontent.com/navanchauhan/SaaS-in-a-Flask/master/misc/screenshots/register.png)

![Basic Dashboard](https://raw.githubusercontent.com/navanchauhan/SaaS-in-a-Flask/master/misc/screenshots/dashboard.png)

![Admin Dashboard](https://raw.githubusercontent.com/navanchauhan/SaaS-in-a-Flask/master/misc/screenshots/admin-dashboard.png)

## Quick How-Tos

### Installing Dependencies

You can either use the provided Pipfile using pipenv or use requirements.txt with pip

```
python3 -m venv venv
source venv/bin/activate
pip3 install pipenv
pipenv install --dev

```
```
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt

```

### Initialise Database and add super-user

```
FLASK_APP=app flask database create
FLASK_APP=app flask database admin-create

```

### Generate SSL Certificate to test Sign in With Google

Even while developing on a local server. You still need to run your server as HTTPS to test Sign in With Google

```
make cert-create
make dev-ssl

```

### Configurations

The following environment variables should be set

#### Sign in with Google

| Variable |
|----------|
|GOOGLE_CLIENT_ID|
|GOOGLE_CLIENT_SECRET|

#### E-Mail Confirmation

| Variable | Example |
|----------|---------|
|MAIL_USE_TLS|True|
|MAIL_PORT|587|
|MAIL_FROM|navan@pi4.navan.dev|
|MAIL_SERVER|pi4.navan.dev|
|MAIL_USERNAME|navan|
|MAIL_PASSWORD|fysdoifhsdfsd|

#### Sentry Error Reporting

| Variable |
|----------|
|SENTRY_DSN|

### Running Tests

You need to be in the base directory of the repo to run tests.

#### Using Pipenv

```
pipenv run tests
```

#### Manually

```
python -m pytest
```

#### GitHub Workflow

The GitHub Workflow automatically installs all dependencies in the requirements.txt file and runs pytest on different Python 3 versions (3.7, 3.8 ,3.9). To generate the requirements.txt file from pipenv use `pipenv lock --dev -r > requirements.txt`

### Code Coverage

[Codecov](https://codecov.io) is used to automatically generate reports and upload to their website using a GitHub Action. Make sure to set up `CODECOV_TOKEN` secret in your repo to use the workflow.