Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Riot_web

Riot_web is a full-stack web project with:

- **front/**: React + Vite frontend (landing pages and UI)
- **backend/**: Node.js + Express API backend

## Project Structure

```text
Riot_web/
├── front/
└── backend/
```

## Prerequisites

- Node.js 16+ (18+ recommended)
- npm

## Run Frontend

```bash
cd front
npm install
npm run dev
```

Frontend scripts:

- `npm run dev` - Start Vite development server
- `npm run build` - Build production assets
- `npm run lint` - Run ESLint
- `npm run preview` - Preview production build locally

## Run Backend

```bash
cd backend
npm install
npm run dev
```

Backend scripts:

- `npm run start` - Start API server with Node.js
- `npm run dev` - Start API server with nodemon
- `npm run data:import` - Import seed data
- `npm run data:destroy` - Destroy seed data

## Notes

- The backend `npm test` script is currently a placeholder and exits with an error by default.
- Frontend and backend can be developed independently in separate terminals.
55 changes: 0 additions & 55 deletions front/README.md

This file was deleted.