https://github.com/gshklovs/react-codex-starter
Vite/FastAPI starter code template with CI and AGENTS.MD file for reliable agentic development. Designed for OpenAI Codex, Claude Code, and Devin.
https://github.com/gshklovs/react-codex-starter
agents claude-code fastapi github-actions openai-codex pytest react template vitest
Last synced: about 2 months ago
JSON representation
Vite/FastAPI starter code template with CI and AGENTS.MD file for reliable agentic development. Designed for OpenAI Codex, Claude Code, and Devin.
- Host: GitHub
- URL: https://github.com/gshklovs/react-codex-starter
- Owner: gshklovs
- Created: 2025-06-04T18:32:38.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-05T07:07:05.000Z (12 months ago)
- Last Synced: 2025-08-07T04:51:25.637Z (10 months ago)
- Topics: agents, claude-code, fastapi, github-actions, openai-codex, pytest, react, template, vitest
- Language: JavaScript
- Homepage:
- Size: 76.2 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vite: React + FastAPI + GitHub Actions template for agents
This project provides a minimal FastAPI backend with a Vite + React frontend. It implemenets a GitHub Actions workflow for running tests on every push and pull request using pytest and vitest. AGENTS.MD is used for improved PRs from OpenAI Codex.
## Requirements
- Python 3.10+
- Node.js 18+
## Setup
All commands should be run from the `frontend` directory.
1. Clone the repository:
```bash
git clone https://github.com/gshklovs/react-codex-starter.git
```
2. Navigate to the frontend directory:
```bash
cd frontend
```
3. Install frontend dependencies:
```bash
npm install
```
4. Install backend dependencies:
```bash
npm run install:backend
```
## Development
Start both frontend and backend servers with a single command:
```bash
cd frontend
npm run dev:all
```
Or run them separately:
**Frontend:**
```bash
cd frontend
npm run dev
```
**Backend:**
```bash
cd backend
uvicorn app.main:app --reload
```
The frontend will be available at http://localhost:5173
The backend API will be available at http://localhost:8000
## Tests
### Backend
```bash
cd backend
pytest
```
### Frontend
```bash
cd frontend
npm test
```
The backend tests verify the `/api/hello` route. The frontend tests use Vitest and React Testing Library to check component rendering and behavior.
## Continuous Integration
This repository uses GitHub Actions to run tests automatically on every push and pull request. The workflow installs dependencies and executes the same test commands described above.
To run the tests locally:
```bash
pip install -r backend/requirements.txt
npm install --prefix frontend
cd backend && pytest
cd frontend && npm test
```
If any step fails, the workflow marks the commit as failed on GitHub.