https://github.com/workfloworchestrator/pydantic-forms-ui
NPM package that implements forms generated by the pydantic forms module
https://github.com/workfloworchestrator/pydantic-forms-ui
Last synced: 5 months ago
JSON representation
NPM package that implements forms generated by the pydantic forms module
- Host: GitHub
- URL: https://github.com/workfloworchestrator/pydantic-forms-ui
- Owner: workfloworchestrator
- Created: 2024-11-14T12:36:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-10T14:15:12.000Z (about 1 year ago)
- Last Synced: 2025-04-10T15:52:06.536Z (about 1 year ago)
- Language: TypeScript
- Size: 813 KB
- Stars: 2
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pydantic forms example
This repository contains a working example of a [FastAPI][1] application with the pydantic forms frontend and backend modules working together.
It shows how you can use the [pydantic forms pypy module][2] on top of pydantic models to automatically generate forms on the frontend using the [pydantic forms npm module][3] that ask for user input. It also show validation and processing of the user input.
## Installation
This example application creates as FastApi application to serve as a backend for a react frontend.
### backend
To install using a virtual environment:
```
$ cd backend
$ python -m venv env
$ source env/bin/activate
$ pip install -r requirements.txt
$ fastapi dev main.py
```
Visit [http://127.0.0.1:8000/docs][4] to view the api documentation
### frontend
```
$ cd frontend
$ npm i
$ npm run dev
```
Visit [http://127.0.0.1:3000][5] to view the generated form
to regenerate the pydantic forms ui package, also perform those steps in `pydantic-forms-ui/frontend/packages/pydantic-forms/`
## Contributing
When setting up this repo to contribute initialize the pre-commit hooks using [pre-commit][6] (eq. `brew install pre-commit`).
For installing prec
```
$ pre-commit install
```
## Publishing to npm
This repository is also used to publish the pydantic forms ui package to NPM.
[1]: https://fastapi.tiangolo.com/
[2]: https://pypi.org/project/pydantic-forms
[3]: https://www.npmjs.com/package/pydantic-forms
[4]: http://127.0.0.1:8000/docs
[5]: http://127.0.0.1:3000
[6]: https://pre-commit.com/#install