Skip to content

Added a getting started section to README.md #25

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
ken-980 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added a getting started section to README.md #25

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .yarnrc.yml
View file
Open in desktop
Copy link
Member

@amaan-bhati amaan-bhati Nov 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need to add the changes of this file in this pull request

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodeLinker: node-modules
40 changes: 35 additions & 5 deletions README.md
View file
Open in desktop
Copy link
Member

@amaan-bhati amaan-bhati Nov 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ony add the changes on the readme file in this pull request, no need to add changes in the other files.

Original file line number Diff line number Diff line change
@@ -1,7 +1,37 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).

## Getting Started

### Installation

First, clone the repo

```bash
git clone git@github.com:daabChingrii/website.git
```

```bash
cd webiste
yarn install && yarn build
yarn start
```

## Running the project locally

Run the development server:

```bash
cd website
yarn install
yarn run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

<!-- How to use -->

<!-- This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). -->

<!-- ## Getting Started

First, run the development server:

```bash
Expand All @@ -12,9 +42,9 @@ yarn dev
pnpm dev
# or
bun dev
```
``` -->

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
<!-- Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

Expand All @@ -33,4 +63,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/app/building-your-application/deploying) for more details.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. -->
Loading