https://github.com/pascalallen/py-react-kit
py-react-kit is a fully containerized dev kit designed to get you up and running fast for Python and React development.
https://github.com/pascalallen/py-react-kit
Last synced: 10 months ago
JSON representation
py-react-kit is a fully containerized dev kit designed to get you up and running fast for Python and React development.
- Host: GitHub
- URL: https://github.com/pascalallen/py-react-kit
- Owner: pascalallen
- License: mit
- Created: 2024-01-16T21:20:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T15:49:21.000Z (over 1 year ago)
- Last Synced: 2025-01-06T05:41:48.508Z (over 1 year ago)
- Language: Python
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-react-kit
py-react-kit is a fully containerized dev kit designed to get you up and running fast for Python and React development. This kit ships with:
- Docker + Docker configuration
- a Python server
- a Postgres database
- Adminer as a DB GUI
- an API built with Flask + GraphQL
- an ORM built with SQLAlchemy
- a React client
- TypeScript
- Webpack
- and helper scripts
## Prerequisites
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
## Development Environment Setup
### Clone Repository
```bash
cd && git clone https://github.com/pascalallen/py-react-kit.git
```
### Copy & Modify `.env` File
```bash
cp .env.example .env
```
### Bring Up Environment
```bash
bin/up
```
You will find the site running at [http://localhost:8080/](http://localhost:8080/)
### Install JavaScript Dependencies
```bash
bin/yarn ci
```
### Compile TypeScript with Webpack
```bash
bin/yarn build
```
### Watch For Frontend Changes
```bash
bin/yarn watch
```
### Take Down Environment
```bash
bin/down
```
### Interact with the Python image
```bash
bin/exec
```
## 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 tests as appropriate.
## License
[MIT](LICENSE)