https://github.com/europanite/standard_react_fastapi_environment

A standard React FastAPI environment
https://github.com/europanite/standard_react_fastapi_environment

android docker docker-compose expo expo-go fastapi ios postgres react react-native typescript web

Last synced: 3 months ago
JSON representation

A standard React FastAPI environment

• Host: GitHub
• URL: https://github.com/europanite/standard_react_fastapi_environment
• Owner: europanite
• License: apache-2.0
• Created: 2025-09-03T14:22:36.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-09-18T23:04:04.000Z (9 months ago)
• Last Synced: 2025-09-19T00:32:48.707Z (9 months ago)
• Topics: android, docker, docker-compose, expo, expo-go, fastapi, ios, postgres, react, react-native, typescript, web
• Language: TypeScript
• Homepage:
• Size: 453 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# [Standard React FastAPI Environment](https://github.com/europanite/standard_react_fastapi_environment "Standard React FastAPI Environment")

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

![OS](https://img.shields.io/badge/OS-Linux%20%7C%20macOS%20%7C%20Windows-blue)

[![Python](https://img.shields.io/badge/python-3.9|%203.10%20|%203.11|%203.12|%203.13-blue)](https://www.python.org/)

[![CI](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/ci.yml/badge.svg)](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/ci.yml)

[![Python Lint](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/lint.yml/badge.svg)](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/lint.yml)

[![pages-build-deployment](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/pages/pages-build-deployment)

[![CodeQL Advanced](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/codeql.yml/badge.svg)](https://github.com/europanite/standard_react_fastapi_environment/actions/workflows/codeql.yml)

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

![Pytest](https://img.shields.io/badge/pytest-%23ffffff.svg?style=for-the-badge&logo=pytest&logoColor=2f9fe3)

![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)

![React Native](https://img.shields.io/badge/react_native-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)

![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)

![Expo](https://img.shields.io/badge/expo-1C1E24?style=for-the-badge&logo=expo&logoColor=#D04A37)

!["web_ui"](./assets/images/web_ui.png)

**full-stack development environment** using:

- **Frontend**: [Expo](https://expo.dev/) ([React Native](https://reactnative.dev/) + [TypeScript](https://www.typescriptlang.org/))  

  - Runs on **Web, Android, and iOS** with a single codebase

- **Backend**: [FastAPI](https://fastapi.tiangolo.com/) (Python)  

- **Database**: [PostgreSQL](https://www.postgresql.org/)

- **Container**: [Docker Compose](https://docs.docker.com/compose/) for consistent development setup

---

## Features

- **Cross-platform frontend** with Expo  

  - Runs as a **web app** or on **Android/iOS devices** via Expo Go or standalone builds

- **CRUD operations** : Create, Read, Update, Delete records

- **Auth operations** : Signup, Signin, Signout

- **FastAPI backend** with automatic docs

  - REST API with Swagger UI (/docs)

---

## 🚀 Getting Started

### 1. Prerequisites

- [Docker Compose](https://docs.docker.com/compose/)

- [Expo Go](https://expo.dev/go) (for Android/iOS testing)

### 2. Build and start all services:

```bash

# set environment variables:

export REACT_NATIVE_PACKAGER_HOSTNAME=${YOUR_HOST}

# Build the image

docker compose build

# Run the container

docker compose up

```

---

### 3. Test:

```bash

# Backend pytest

docker compose \

  -f docker-compose.test.yml run \

  --rm \

  --entrypoint /bin/sh backend_test \

  -lc ' pytest -q '

# Backend Lint

docker compose \

  -f docker-compose.test.yml run \

  --rm \

  --entrypoint /bin/sh backend_test \

  -lc 'ruff check /app /tests'

# Frontend Test

docker compose \

  -f docker-compose.test.yml run \

  --rm frontend_test

```

---

### 4. Visit the services:

- Backend API: http://localhost:8000/docs

!["backend"](./assets/images/backend.png)

- Frontend UI (WEB): http://localhost:8081

- Frontend UI (mobile): exp://${YOUR_HOST}:8081: access it with the QR provided by Expo.

!["expo"](./assets/images/expo.png)

---

# License

- Apache License 2.0