fastapi-starter
A FastAPI based low code starter/boilerplate: SQLAlchemy 2.0 (async), Postgres, React-Admin, pytest and cypress
File Explorer
Download Latest Version (.zip)- cookiecutter-project-test.yml
- deploy-demo.yml
- pre-commit.yaml
- dependabot.yml
- items.png
- login.png
- deploy-demo-project-to-fly.sh
- fly.toml
- test.sh
- pre-commit.yaml
- test.yaml
- dependabot.yml
- 5c89a726934c_add_item_migration.py
- 7e09fa75df7a_add_initial_migration.py
- env.py
- README
- script.py.mako
- __init__.py
- items.py
- users.py
- utils.py
- config.py
- logger.py
- db.py
- request_params.py
- users.py
- __init__.py
- item.py
- user.py
- item.py
- msg.py
- request_params.py
- user.py
- db.py
- factory.py
- index.html
- __init__.py
- test_items.py
- test_utils.py
- test_user.py
- __init__.py
- conftest.py
- utils.py
- alembic.ini
- Dockerfile
- main.py
- poetry.lock
- pyproject.toml
- shell.py
- app.cy.js
- index.js
- commands.js
- e2e.js
- favicon.ico
- index.html
- logo192.png
- logo512.png
- manifest.json
- robots.txt
- AdminLayout.tsx
- Auth.tsx
- authStyles.tsx
- FILES
- VERSION
- auth-api.ts
- items-api.ts
- users-api.ts
- bearer-response.ts
- detail.ts
- error-model.ts
- httpvalidation-error.ts
- index.ts
- item-create.ts
- item-update.ts
- item.ts
- user-create.ts
- user-read.ts
- user-update.ts
- validation-error-loc-inner.ts
- validation-error.ts
- .gitignore
- .npmignore
- .openapi-generator-ignore
- api.ts
- base.ts
- common.ts
- configuration.ts
- git_push.sh
- index.ts
- Dashboard.test.tsx
- Dashboard.tsx
- Items.tsx
- Login.test.tsx
- Login.tsx
- ProfileEdit.tsx
- Register.test.tsx
- Register.tsx
- Users.tsx
- authProvider.ts
- env.ts
- App.css
- App.tsx
- index.css
- index.tsx
- logo.svg
- react-app-env.d.ts
- reportWebVitals.ts
- setupTests.ts
- .dockerignore
- .gitignore
- .prettierignore
- cypress.config.ts
- Dockerfile
- nginx.conf
- openapitools.json
- package.json
- README.md
- tsconfig.json
- yarn.lock
- .dockerignore
- .env
- .gitignore
- .isort.cfg
- .pre-commit-config.yaml
- docker-compose.ci.yml
- docker-compose.override.yml
- docker-compose.yml
- Dockerfile
- env-template
- README.md
- .all-contributorsrc
- .gitignore
- .pre-commit-config.yaml
- cookiecutter.json
- LICENSE
- README.md
# Installation Guide
git clone https://github.com/gaganpreet/fastapi-starter
Downloads the entire project code from GitHub to your computer.
cd fastapi-starter
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Python 3 Python is required to use pip.
pip3 install cookiecutter
Installs the package published on PyPI directly β no need to clone the source.
pip3 install cruft
Installs the package published on PyPI directly β no need to clone the source.
Pulled directly from this repo's README.
3. Docker
Easy- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f {{cookiecutter.project_slug}}/docker-compose.ci.yml up -d --build
Runs the command against the services defined in the compose file.
4. Node.js
Easycd {{cookiecutter.project_slug}}/frontend
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
5. Python
Easypip3 install cookiecutter
Installs the package published on PyPI directly β no need to clone the source.
pip3 install cruft
Installs the package published on PyPI directly β no need to clone the source.
Pulled directly from this repo's README.