https://github.com/nelsontanko/sass-platform
A SaaS app built with Django, Neon DB, Allauth...
https://github.com/nelsontanko/sass-platform
allauth django docker postgresql python redis sass stripe
Last synced: 4 months ago
JSON representation
A SaaS app built with Django, Neon DB, Allauth...
- Host: GitHub
- URL: https://github.com/nelsontanko/sass-platform
- Owner: nelsontanko
- License: mit
- Created: 2024-09-04T09:19:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-12T18:53:11.000Z (over 1 year ago)
- Last Synced: 2025-02-09T22:42:53.404Z (over 1 year ago)
- Topics: allauth, django, docker, postgresql, python, redis, sass, stripe
- Language: HTML
- Homepage:
- Size: 196 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SaaS Starter
An advanced starter guide for building Software as a Service business by leveraging Django, Tailwind, htmx, Neon Postgres, Redis, and more.
The goal of this project is to learn how to create a reusable foundation for building SaaS products. When release.
## Getting Started
### Clone
```bash
mkdir -p ~/dev/saas
cd ~/dev/saas
git clone https://github.com/peternelson063/sass-platform .
```
### Create Virtual Environment
*macOS/Linux*
```bash
python3 --version # should be 3.11 or higher
python3 -m venv venv
source venv/bin/activate
```
*Windows*
```bash
c:\Python312\python.exe -m venv venv
.\venv\Scripts\activate
```
### Install Requirements
```bash
# with venv activated
pip install pip --upgrade && pip install -r requirements.txt
```
### Sample dotenv to dotnev
```bash
cp .env.sample .env
cat .env
```
Values include:
- `DJANGO_DEBUG=1`
- `DJANGO_SECRET_KEY=""`
- `DATABASE_URL=""`
- `EMAIL_HOST="smtp.gmail.com"`
- `EMAIL_PORT="587"`
- `EMAIL_USE_TLS=True`
- `EMAIL_USE_SSL=False`
- `EMAIL_HOST_USER=""`
- `EMAIL_HOST_PASSWORD=""`
- `ADMIN_USER_EMAIL=""`
- `STRIPE_SECRET_KEY=""`
### NOTE
For dev environment, the sqlite3 db could be used
### Create the _DJANGO_SECRET_KEY_
```bash
python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'
```
or
```bash
openssl rand -base64 64
```
or
```bash
python -c 'import secrets; print(secrets.token_urlsafe(64))'
```
Once you have this value, add update `DJANGO_SECRET_KEY` in `.env`.
### Run Migrations
```bash
source venv/bin/activate
# or .\venv\Scripts\activate if windows
cd src
python manage.py migrate
```
### Create a Superuser
```bash
python manage.py createsuperuser
```
### Pull Vendor Static Files
```bash
python manage.py vendor_pull
```
### Run the Server
```bash
python manage.py runserver
```