From e0ddafb00520000904034b6fe9863e5769b35f88 Mon Sep 17 00:00:00 2001 From: Jiajun Xu Date: Thu, 24 Apr 2025 20:32:21 -0700 Subject: [PATCH] add instruction to readme --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b73354..8a04ab9 100644 --- a/README.md +++ b/README.md @@ -1 +1,43 @@ -# hello friends ! \ No newline at end of file +# hello friends ! + + +# To Run the Website Locally + +### Prerequisites + +- [Node.js](https://nodejs.org/) version 18.17.1 or higher (we recommend using NVM to manage Node versions) +- [pnpm](https://pnpm.io/) (optional but recommended) + +### Step 1: Install correct Node.js version + +If you have NVM (Node Version Manager) installed: + +```bash +nvm install 18.17.1 +nvm use 18.17.1 +``` + +Verify your Node.js version: + +```bash +node -v +``` + +### Step 2: Install dependencies + +```bash +npm install +``` + +### Step 3: Start the development server + +```bash +npx astro dev +``` + +## Tech Stack + +- [Astro](https://astro.build/) - The core framework +- [React](https://reactjs.org/) - For interactive components +- [Tailwind CSS](https://tailwindcss.com/) - For styling +- [TypeScript](https://www.typescriptlang.org/) - For type safety \ No newline at end of file