Skip to content

fix: update README with clone, install steps and Node v15+ requiremen… #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
farheenayy33 wants to merge 1 commit into
base: main
Choose a base branch
from
+30 −2
Open

fix: update README with clone, install steps and Node v15+ requiremen… #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.