docs: update LICENSE, README, architecture diagram

This commit is contained in:
2026-07-11 21:49:49 +02:00
parent ff39680106
commit aa31e1bdcd
4 changed files with 174 additions and 69 deletions

View File

@@ -1,87 +1,32 @@
# Welcome to React Router!
# PocketChords — Frontend
A modern, production-ready template for building full-stack React applications using React Router.
React Router v7 SPA with Tailwind CSS and shadcn/ui. Mobile-first design for viewing chord charts while playing.
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/remix-run/react-router-templates/tree/main/default)
## Features
- 🚀 Server-side rendering
- ⚡️ Hot Module Replacement (HMR)
- 📦 Asset bundling and optimization
- 🔄 Data loading and mutations
- 🔒 TypeScript by default
- 🎉 TailwindCSS for styling
- 📖 [React Router docs](https://reactrouter.com/)
## Getting Started
### Installation
Install the dependencies:
## Setup
```bash
npm install
```
### Development
Start the development server with HMR:
## Development
```bash
npm run dev
```
Your application will be available at `http://localhost:5173`.
Opens at `http://localhost:5173`. Set `VITE_API_URL` in `.env` to point to the backend (defaults to `/api`).
## Building for Production
Create a production build:
## Build
```bash
npm run build
```
## Deployment
Outputs static files to `build/client/`. The Rust backend serves these in production.
### Docker Deployment
## Stack
To build and run using Docker:
```bash
docker build -t my-app .
# Run the container
docker run -p 3000:3000 my-app
```
The containerized application can be deployed to any platform that supports Docker, including:
- AWS ECS
- Google Cloud Run
- Azure Container Apps
- Digital Ocean App Platform
- Fly.io
- Railway
### DIY Deployment
If you're familiar with deploying Node applications, the built-in app server is production-ready.
Make sure to deploy the output of `npm run build`
```
├── package.json
├── package-lock.json (or pnpm-lock.yaml, or bun.lockb)
├── build/
│ ├── client/ # Static assets
│ └── server/ # Server-side code
```
## Styling
This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
---
Built with ❤️ using React Router.
- React 19 + React Router 7 (SPA mode)
- Tailwind CSS 4 + shadcn/ui
- Tonal (music theory / chord voicings)
- Vite