blob: e1c689a1eaa541fddd33bdb28294fde183ce913c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
# SaaS-in-a-Flask
[](https://codecov.io/gh/navanchauhan/SaaS-in-a-Flask)
[](https://github.com/navanchauhan/SaaS-in-a-Flask/actions/workflows/Flask-Tests.yaml)
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
- [x] **Landing Page:** Written in Bootstrap 5, compatible with [Bootswatch Themes](https://bootswatch.com)
- [ ] Database Management
- **Authentication:** Using Flask-Login
- [x] Sign Up
- [x] Sign In
- [ ] OAuth2
- [ ] LDAP
- [ ] Forgot Password
- [ ] Confirm Email
- [x] **Password Hashing:** Using Bcrypt (Flask-Bcrypt)
- [x] **Form Handling:** With Flask-WTF using WTForms
- [x] Dashboard
- [x] GitHub Workflows
- [ ] Admin Pages
- [ ] Role Support
- [ ] Team Management
- Error Handling
- [ ] Sentry Support
- [ ] Error Code Handling
- [ ] Custom Exceptions
- [x] 404,500,401 e.t.c
- [ ] Async AJAX Calls
- [x] **Tests:** Using PyTest
- [x] **Code Coverage:** Using CodeCov
- [ ] Delayed Jobs
- [ ] Logging
- [ ] FastAPI Support
- Billing Handling
- [ ] Stripe
- [ ] GDPR Compliance / Data Export
- [ ] Docker Images
## Quick How-Tos
### Makefile
#### Install Dependencies using pip
```
make install
```
#### Initialise Database
```
make db
```
#### Run Development Server
```
make dev
```
### 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.
|
