buildout full stack functionality
This commit is contained in:
53
README.md
53
README.md
@@ -1,2 +1,55 @@
|
||||
# react-dotnet
|
||||
|
||||
### A minimal monorepo skeleton project jumpstarter.
|
||||
### NET backend
|
||||
### React/Vite frontend.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [.NET SDK](https://dotnet.microsoft.com/download) (project targets `net10.0`)
|
||||
- [Node.js](https://nodejs.org/) (LTS recommended)
|
||||
|
||||
## Backend
|
||||
|
||||
From the repository root:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
dotnet run
|
||||
```
|
||||
|
||||
The API runs at `http://localhost:5231`. Swagger UI is available in Development at `http://localhost:5231/swagger`.
|
||||
|
||||
Skeleton endpoints:
|
||||
|
||||
- `GET /health` — liveness check
|
||||
- `GET /v1/info` — app name, version, environment, and server timestamp
|
||||
|
||||
## Frontend
|
||||
|
||||
From the repository root:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
The app runs at `http://localhost:3000`.
|
||||
|
||||
Copy `.env.example` to `.env.development` (or `.env.local`) if you need to customize the API URL:
|
||||
|
||||
```
|
||||
VITE_API_BASE_URL=http://localhost:5231
|
||||
```
|
||||
|
||||
## Running both
|
||||
|
||||
Start the backend and frontend in separate terminals. The backend CORS policy allows requests from `http://localhost:3000`.
|
||||
|
||||
## Project structure
|
||||
|
||||
```
|
||||
backend/ ASP.NET Core Web API
|
||||
frontend/ React + Vite + TypeScript SPA
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user