diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec30f1d --- /dev/null +++ b/README.md @@ -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. diff --git a/front/README.md b/front/README.md deleted file mode 100644 index 0e11508..0000000 --- a/front/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# Riot Gaming Web - -Welcome to the Riot Gaming Web project! This is a modern, visually engaging landing page for the Riot gaming universe, built with React, Vite, and Tailwind CSS.(This is just a Landing Page) - -## Features - -- Animated hero and story sections -- Responsive design for all devices -- Creative use of images, video, and gradients -- Smooth UI interactions and effects -- Easy to customize and extend - -## Getting Started - -### Prerequisites - -- Node.js (v16 or higher recommended) -- npm (comes with Node.js) - -### Installation - -1. Clone this repository or download the source code. -2. Open a terminal and navigate to the project directory: - ```sh - cd Riot - ``` -3. Install dependencies: - ```sh - npm install - ``` - -### Running the Development Server - -Start the local development server with: - -```sh -npm run dev -``` - -Then open the provided local URL in your browser (usually http://localhost:5173). - -## Project Structure - -- `src/` - Main source code (components, styles, etc.) -- `public/` - Static assets (images, audio, fonts, videos) -- `index.html` - Main HTML entry point -- `package.json` - Project metadata and scripts - -## Customization - -You can easily update images, text, and styles in the `src/components` and `public` folders to match your own branding or content. - -## License - -This project is for educational and demo purposes. Please contact the author for commercial use.