Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 8 days 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.

Awesome Lists containing this project

README

        

# py-react-kit

![GitHub](https://img.shields.io/github/license/pascalallen/py-react-kit)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/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. 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)