Skip to content
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.

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

feat: Update README.md to fit conventional README styles #2274

Open
wants to merge 1 commit into
base: testing
Choose a base branch
from
Open
Changes from all commits
Commits
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
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,22 @@ We trust that you will not copy this idea/project, this is at the end for the sa

### Running the App Locally

- Ensure you have the latest `nodejs` and `npm` installed. Prefer 10+
- Ensure you have `yarn` installed. Simply `npm i -g yarn`
- Clone this repo
- Run `yarn` on the repo to install `node_modules`
- Run `yarn dev` to start the app. If you wish to run on a different port, run `yarn dev -p 8000`
- Open `localhost:3000` in your browser
```bash
# Ensure you have node.js and npm installed (Prefer 18.17.0+)
node -v
npm -v
# Install yarn globally if not installed
npm i -g yarn
# Clone the repository
git clone https://github.com/quran/quran.com-frontend-next
cd quran.com-frontend-next
# Install dependencies
yarn
# Start the application
yarn dev
# To run on a different port, use:
yarn dev -p 8000
```

The app runs on Next.js and will automatically hot reload when you make changes.

Expand Down