Skip to content

Latest commit

 

History

History
169 lines (125 loc) · 7.07 KB

README.md

File metadata and controls

169 lines (125 loc) · 7.07 KB
Raw

Warning

This project is no longer maintained.

Updates Build Status codecov Documentation Status

Cookiecutter SaaS is a highly specialised project template for SaaS websites. It is based on Django with full (optional) React & Redux support. Screenshots

Features

Note: This section is incomplete, see #47

  • Docker on development and production
  • 100% project test coverage
  • subscription management out of the box with stripe
  • invoicing and VAT collection
  • React and Redux integration (optional)
  • Private beta mode
  • Free subscription support (freemium & trial)
  • On production:
    • Error log aggregation and notification
    • Application monitoring
    • Managed newsletter sign ups
    • HTTPs out of the box (Let's encrypt)
    • Zero downtime deployments

This is only a small subset of available features. Show all Features

Stack

Note: This section is incomplete, see #46

  • Django
  • Celery task queue
  • React & Redux (optional)
  • Redis
  • Postgres
  • Caddy web server

Want to know more? Check out the stack section in the docs.

Installation

First, you need to install Cookiecutter:

pip install cookiecutter

Now run it against this repo:

cookiecutter https://github.com/jayfk/cookiecutter-saas

Cookiecutter will prompt you for some options on how the project should be generated for you. If you are doing this for the first time, check out the prompts section in the docs.

project_name [project_name]: Demo
project_slug [demo]:
author_name [Jannis Gebauer]:
email [ja.geb@me.com]:
info_mail [ja.geb@me.com]:
domain_name [example.com]: demo.cookiecutter-saas.com
timezone [UTC]:
Select django_long_term_support:
1 - yes
2 - no
Choose from 1, 2 [1]: 2
Select react:
1 - yes
2 - no
Choose from 1, 2 [1]: 1
Select blog:
1 - yes
2 - no
Choose from 1, 2 [1]: 1
Select private_beta:
1 - yes
2 - no
Choose from 1, 2 [1]: 1
Select free_subscription_type:
1 - freemium
2 - trial
3 - None
Choose from 1, 2, 3 [1]: 1

Once Cookiecutter finishes, enter the project directory and take a look around:

cd demo/
ls -la

Developing locally

Prereqiuisites

Cookiecutter SaaS uses Docker for development and production, make sure Docker and Docker Compose are installed. If you are planning to push your project to production (you should), you'll also need to install Docker Machine.

On macOS

Follow the Docker for Mac installation instructions. This will install Docker, Docker Compose and Docker Machine on your Mac.

Windows

Follow the Docker for Windows installation instructions. This will install Docker, Docker Compose and Docker Machine on your Windows machine.

Linux

First, you need to install the Docker engine, follow the Docker on Linux installation instructions. Next, you need to install Docker Compose and install Docker Machine.

Make sure everything is installed correctly by running:

docker --version
docker-compose --version
docker-machine --version

Running the Project

Before running the project for the first time, you need to build it.

Start the build process with:

docker-compose -f dev.yml build

This tells Docker Compose to:

  • pull all required base images from Docker Hub
  • install all python dependencies via pip (and npm if you are going to using react)
  • copy utility scripts into the image
  • set up all required environment variables

This is going to take a while the first time you run it. Subsequent builds will be a lot faster because Docker caches each build step.

While you wait, check out the Third Party Services section. During development - in order to test subscriptions - we just need the Stripe and Octobat keys to be set. Create an account for both services and copy the keys to config/settings/local.py.

Once the build process is completed, run the project with:

docker-compose -f dev.yml up

You should see a lot of log messages flying by as each container is initializing itself. Look at the logs.

django_1    | Django version 1.10, using settings 'config.settings.local'
django_1    | Development server is running at http://0.0.0.0:8000/
django_1    | Using the Werkzeug debugger (http://werkzeug.pocoo.org/)
django_1    | Quit the server with CONTROL-C.
django_1    |  * Debugger is active!
django_1    |  * Debugger pin code: 241-491-852

As soon as you see a log similar to this, your project is ready.

Fire up your browser and go to http://localhost:8000. hello localhost

If you want, you can now create a super user. Open up a second terminal and run:

docker-compose -f dev.yml run django python manage.py createsuperuser

What's next?

Note: Some parts of the documentation are still incomplete. The % next to each link indicates how far the documentation for the topic is.