Skip to content

Commit

Permalink
update read me
Browse files Browse the repository at this point in the history
  • Loading branch information
raythompsonwebdev committed Jan 20, 2024
1 parent 994ee25 commit 6b1103d
Showing 1 changed file with 36 additions and 19 deletions.
55 changes: 36 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![shoestore](/www-shoestore-home-page-large.jpg)

# Description
## Description

Ecommerce Web application based on photoshop website template design downloaded from website [php.jabber.com](https://www.phpjabbers.com/).

Expand Down Expand Up @@ -30,51 +30,68 @@ Built using JS framework NextJS (pages router), NextAuth.js, Typescript, MungoDB
- [Typescript](https://www.typescriptlang.org/)
- [Nextauth](https://next-auth.js.org/)

## Quick Start
## Prerequisites

Install next, react and react-dom :
This is an example of how to list things you need to use the software and how to install them.

`npm install next react react-dom`
- npm
```sh
npm install npm@latest -g
```

### or
### Installation

`yarn add next react react-dom`
Clone the repo

### or
```sh
git clone git@github.com:raythompsonwebdev/shoestore.git
```

`pnpm add next react react-dom`
Install NPM packages :

Open package.json and add the following scripts:
```sh
npm install
```

### or

```sh
yarn install
```
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint"
}

### or

```sh
pnpm install
```

`npm run dev`
Open package.json and add the following scripts:

Runs next dev to start Next.js in development mode.

`npm run dev`

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes. You may also see any lint errors in the console.

Runs next build to build the application for production usage

`npm run build`
```sh
npm run build
```

Runs next start to start a Next.js production server

`npm run start`
```sh
npm run start
```

Runs next lint to set up Next.js' built-in ESLint configuration

`npm run lint`
```sh
npm run lint
```

## Learn More

Expand Down

1 comment on commit 6b1103d

@vercel
Copy link

@vercel vercel bot commented on 6b1103d Jan 20, 2024

Choose a reason for hiding this comment

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

Please sign in to comment.