README.md

A FastAPI Server with a packaged React Application

The story: Packaging Your TypeScript Client into a Python Backend.

A simple demo server for demonsrating how to use a packaged frontend application.

Getting Started

Installation

You can install this server and run it with:

python3 -m venv venv             # create virtual environment
. venv/bin/activate              # activate the vitrual environment
pip install -r requirements.txt  # install dependencies
python -m backend                # run the server

Tests

Unit Tests

Run the following command to execute the project unit-tests:

py.test -o junit_family=xunit2 --junitxml result.xml -xv --ff --cov=backend --cov-report=xml --cov-report=term-missing tests

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update/add tests.

On your first contribution, please install pre-commit:

pre-commit install --install-hooks -t pre-commit -t commit-msg