Skip to content

Commit a0e21c8

Browse files
MDE updated README.md file
1 parent f492789 commit a0e21c8

File tree

1 file changed

+53
-1
lines changed

1 file changed

+53
-1
lines changed

app/front-end/README.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1-
# Coming Soon!
1+
# Development Server Setup Guide
2+
3+
This guide provides instructions on setting up and running a Vite-based development server using React and TypeScript.
4+
5+
## Prerequisites
6+
7+
1. **Node.js**
8+
2. **Visual Studio Code (VS Code)**
9+
10+
## Step 1: Install Node.js and npm
11+
12+
1. **Check Node.js version:**:
13+
```bash
14+
node -v
15+
```
16+
17+
Ensure you have Node.js installed. You can download it from [here](https://nodejs.org/).
18+
19+
2. **Check npm version:**:
20+
```bash
21+
npm -v
22+
```
23+
24+
If npm is not installed, it will be installed automatically with Node.js.
25+
26+
## Step 2: Set Up Your Development Environment
27+
28+
1. **Open VS Code:**:
29+
- Install Visual Studio Code if you haven’t already. Download it from [here](https://code.visualstudio.com/).
30+
31+
2. **Open Your Project Folder:**
32+
- In the VS Code window, open the Command Palette again (`Ctrl+Shift+P`).
33+
- Type `>File: Open Folder...` and navigate to your project folder located on Windows. Open whole github repository (root).
34+
35+
3. **Navigate to front-end application:**
36+
- Press `` Ctrl+Shift+` `` to open the New Terminal. Then navigate to:
37+
38+
```bash
39+
cd app/front-end
40+
```
41+
42+
4. **Install Dependencies:**
43+
44+
```bash
45+
npm install
46+
```
47+
48+
## Step 3: Run the Development Server
49+
```bash
50+
npm run dev
51+
```
52+
53+
This will run the React application with Vite on `http://localhost:5173/`. To shutdown the application press `Ctrl+C` in VS Code terminal.

0 commit comments

Comments
 (0)