Flask Project Template

This README provides instructions on how to use the flask-template.py script to create a new Flask project with a predefined directory structure and necessary files. This is a little project I undertook to save the hassle of having to individually create all the files, folders, testing config, etc. when starting a new project.

This script will create:

All the files and folders necessary to begin a standard Flask project
The databases (either SQLite or PostgreSQL depending on your choice)
The basic configurations for your project including code to create the app, make connections to the databases, and set up the testing environment

NOTE: I am often updating this template, so please check for updates and download the latest version before using it. (Please note that the PostgreSQL option is currently only available for MacOS)

Quick Start

Prerequisites

Python 3.x installed on your system.
Pipenv installed globally on your system. (Click here for instructions)
Knowledge of command line operations.
(If you select the PostgreSQL database option (currently only available on MacOS), you'll need PostgreSQL installed and running on your machine.)

Using the Flask Template Script

Download the Script

Download the flask-template.py script to your local machine.
Run the Script

NOTE: If you are on Windows and haven't yet connected to " 127.0.0.1 ", you may need to open Command Prompt as an administrator, run the command " netsh winsock reset " and then restart your computer.

Open your command line tool and navigate to the directory where you want your new Flask project to be created.

Run the script using Python:
```
python path/to/flask-template.py
```
If for example, you git cloned this repo into Documents, the path to run the file from any other directory would be:
```
# For MacOS:
python ~/Documents/flask-starter-template/flask-template.py
# For Linux:
python3 ~/Documents/flask-starter-template/flask-template.py
# For Windows:
python "C:\Users\<YOUR_USER_NAME>\Documents\flask-starter-template\flask-template.py"
```
Upon running the file, enter the names of your project, app and database.

Once the tests have completed you'll see the message 'Your project is ready!'

If you've set up VS Code correctly, you'll be able to jump into your project by doing:
```
cd YOUR_PROJECT_NAME/
code .
```
(You may need to open VS Code, close it, and open it again.)

Once in your project in VS Code, open a terminal, and if the pipenv shell isn't already activated, do:
```
pipenv shell
```
Now you can run the tests by doing:
```
pytest
```
You can start the server by doing:
```
python run.py
```

Project Structure

The script will create a new directory with your project name and set up a basic Flask project structure inside it, including:

Application directories (models, views, forms, tests, etc.)
Configuration files
A basic Flask application setup
Initial pytests and playwright tests

Installing Pipenv

# For MacOS:
brew install pipenv

# For Linux:
sudo apt install pipenv
pip install --user --upgrade pip

# For Windows:
pip install pipenv

shery7310 / flask-starter-template