From 3f0745442e49f209e0e174e6eae9073289e067fc Mon Sep 17 00:00:00 2001 From: Farheen Laraib Date: Tue, 14 Apr 2026 08:00:13 +0500 Subject: [PATCH] fix: update README with clone, install steps and Node v15+ requirement - fixes #56 --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5fde18f..1932b69 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,35 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next ## Getting Started -First, run the development server: +### Prerequisites +Make sure you have **Node.js v15 or later** installed. Lower versions will cause a `SyntaxError: Unexpected token '??='` error. + +### Clone the Repository + +```bash +# HTTPS +git clone https://github.com/firstcontributions/frontend.git + +# SSH +git clone git@github.com:firstcontributions/frontend.git + +# GitHub CLI +gh repo clone firstcontributions/frontend +``` + +### Install Dependencies + +First, install the required dependencies: + +```bash +npm install +# or +yarn install +``` + +### Run the Development Server + +Then, run the development server: ```bash npm run dev @@ -34,4 +62,4 @@ You can check out [the Next.js GitHub repository](https://github.com/vercel/next The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. \ No newline at end of file