chore: update readme
This commit is contained in:
parent
de7f7bbcfd
commit
7de3a5cf49
71
README.md
71
README.md
@ -10,3 +10,74 @@ Currently, two official plugins are available:
|
|||||||
## Expanding the ESLint configuration
|
## Expanding the ESLint configuration
|
||||||
|
|
||||||
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
|
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
|
||||||
|
|
||||||
|
# Project Name
|
||||||
|
|
||||||
|
Fendi home react app.
|
||||||
|
|
||||||
|
## 🚀 Getting Started
|
||||||
|
|
||||||
|
Follow the steps below to set up and run this project locally.
|
||||||
|
|
||||||
|
### 📦 1. Clone the Repository
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/your-username/your-repo-name.git
|
||||||
|
cd your-repo-name
|
||||||
|
|
||||||
|
### 🧑💻 2. Open the Project in Your IDE
|
||||||
|
|
||||||
|
We recommend using [Visual Studio Code](https://code.visualstudio.com/download), available for:
|
||||||
|
|
||||||
|
- macOS
|
||||||
|
- Linux
|
||||||
|
- Windows
|
||||||
|
|
||||||
|
You may also use any IDE or code editor of your choice.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🛠 3. Install Node.js (if not installed)
|
||||||
|
|
||||||
|
Download and install Node.js from the official website:
|
||||||
|
👉 [https://nodejs.org/en/download](https://nodejs.org/en/download)
|
||||||
|
|
||||||
|
To verify that Node.js and npm are installed correctly, run the following commands in your terminal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node -v
|
||||||
|
npm -v
|
||||||
|
|
||||||
|
### 📥 4. Install Dependencies
|
||||||
|
|
||||||
|
Open a terminal and navigate to the root folder of the project, then run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
|
||||||
|
### ▶️ 5. Run the Development Server
|
||||||
|
|
||||||
|
To start the app in development mode, run the following command in your terminal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
You should see output indicating the server is running, typically at:
|
||||||
|
http://localhost:5173
|
||||||
|
|
||||||
|
|
||||||
|
### 🌐 6. Open the App in Your Browser
|
||||||
|
|
||||||
|
Once the development server is running, open your browser and navigate to:
|
||||||
|
http://localhost:5173
|
||||||
|
|
||||||
|
You should now see the application running locally.
|
||||||
|
|
||||||
|
|
||||||
|
## ✅ Requirements
|
||||||
|
|
||||||
|
Make sure you have the following installed before running the project:
|
||||||
|
|
||||||
|
- [Node.js](https://nodejs.org/) (v18 or later recommended)
|
||||||
|
- A code editor (e.g., [Visual Studio Code](https://code.visualstudio.com/))
|
||||||
|
- A modern web browser (e.g., Chrome, Firefox, Safari)
|
||||||
Loading…
Reference in New Issue
Block a user