Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zackees committed Apr 27, 2023
1 parent 27ff741 commit 2bdfa0a
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,22 @@ FastAPI app creation template
[![Ubuntu_Tests](../../actions/workflows/push_ubuntu.yml/badge.svg)](../../actions/workflows/push_ubuntu.yml)
[![Win_Tests](../../actions/workflows/push_win.yml/badge.svg)](../../actions/workflows/push_win.yml)

To develop software, run `. ./activate.sh`

# Instructions

First off, make sure you have python installed and this package `pip install make-fastapi-app`

1. Create a new python github repo, let's call it "myapp"
2. Clone that "myapp" repo to your local computer
3. `cd` into "myapp`
4. Run `createfastapiapp` at the project root.
5. Now `git commit` the files into the repo.

Now you should have a fully formed app that is ready to be used at Render.com or DigitalOcean, which will use the Dockerfile install. Everything should be automatic with this option.

## Running locally

You can either run the app locally. See the run scripts at the project root. You'll need to install the project globally with `pip install -e .` or else use a virtual environment with `python make_venv.py` and then using `. ./activate.sh` and then `pip install -e .` and then running the `run_dev.py` which should launch everything. Also there is a VSCode build tool that will do this automatically. It will be something like `Terminal` -> `Run Build Tools` -> `Run Local`

# Windows

Expand All @@ -25,4 +40,4 @@ Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.
* 1.0.3: Adds post install instructions to the command line.
* 1.0.2: Remove trailing `.git` and `/` for githurl repo input
* 1.0.1: Adds +x to all shell scripts
* 1.0.0: Initial commit
* 1.0.0: Initial commit

0 comments on commit 2bdfa0a

Please sign in to comment.