https://github.com/blackbaba/flask-tailwind-saas-starter-template

SAAS Starter Template using Flask and TailwindCSS
https://github.com/blackbaba/flask-tailwind-saas-starter-template

Last synced: over 1 year ago
JSON representation

SAAS Starter Template using Flask and TailwindCSS

• Host: GitHub
• URL: https://github.com/blackbaba/flask-tailwind-saas-starter-template
• Owner: blackbaba
• License: mit
• Created: 2021-12-19T07:37:54.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-28T10:27:22.000Z (over 4 years ago)
• Last Synced: 2025-01-23T08:45:35.173Z (over 1 year ago)
• Language: Python
• Size: 4.25 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Flask and TailwindCSS SAAS App Starter Template

## THIS TEMPLATE IS A WORK IN PROGRESS

![Flask Tailwind SAAS Starter Preview](app/static/preview.png)

![Flask Tailwind SAAS Starter Preview](app/static/preview2.png)

## How to use

1. Clone this repo and create a virtual environment (`python3 -m venv venv`) for use with this application.

2. Activate the virtual environment (`source venv/bin/activate`) and run `pip install -r requirements.txt` to install package dependencies.

3. Download the [TailwindCSS standalone build tool](https://tailwindcss.com/blog/standalone-cli) and place the executable in the project folder.

4. In one terminal - run `./tailwindcss -i ./app/static/src/css/tailwind.css -o ./app/static/src/css/index.css --watch`. This will start the Tailwind JIT Watcher and will compile your CSS on the fly.

5. In the second terminal - setup some ENV variables required to run the Flask application:

   - Run `export FLASK_APP=run.py` (use `set` instead of `export` for windows)

   - Run `export FLASK_ENV=development`

   - Customise the application configuration in `config.py` as per your requirements

   - Run `flask db upgrade` to intialise database

   - Run `flask run` to start the Flask development server

6. You can now add/remove CSS in your jinja templates, it will be auto-compiled by the compiler running in step 4. You will see the Tailwind CSS styles when you refresh your browser (Flask server) window.

7. Before deploying to production:

   - Stop the flask server and the Tailwind CLI build tool.

   - Run `flask assets clean` followed by `flask assets compile` to prepare the CSS and JSS assets for production

8. Deploy to production. Enjoy!