diff --git a/README.md b/README.md index 4b6dc5e..ec8d9dd 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,11 @@ 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 @@ -22,8 +24,6 @@ We recommend using [Visual Studio Code](https://code.visualstudio.com/download), 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: @@ -31,28 +31,33 @@ Download and install Node.js from the official website: To verify that Node.js and npm are installed correctly, run the following commands in your terminal: +
```bash node -v -npm -v +npm -v``` +### 📥 4. Install Dependencies Open a terminal and navigate to the root folder of the project, then run: +
```bash -npm install +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 +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: @@ -60,7 +65,6 @@ http://localhost:5173 You should now see the application running locally. - ## ✅ Requirements Make sure you have the following installed before running the project: @@ -70,7 +74,6 @@ Make sure you have the following installed before running the project: - A modern web browser (e.g., Chrome, Firefox, Safari) - ## React + Vite This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. @@ -82,5 +85,4 @@ Currently, two official plugins are available: ## 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. \ No newline at end of file