Skip to content

Commit b8c71e3

Browse files
committed
chore: Require Nodejs 18.14.2 and update READMEs
1 parent d162be6 commit b8c71e3

File tree

6 files changed

+68
-25
lines changed

6 files changed

+68
-25
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,30 @@
22

33
A React (NextJS) playground for testing using react hooks.
44

5+
## Requirements
6+
7+
The following dependecies are used for this project. Feel free to experiment using other dependencies and versions.
8+
9+
1. Windows 64-bit OS
10+
2. nvm version 1.1.9 (for Windows)
11+
- NOTE: Using nvm is optional if you want to continue using your pre-installed NodeJS.
12+
3. NodeJS LTS v18.14.2 installed using nvm
13+
- node v18.14.2
14+
- npm v9.5.0
15+
- > **NOTE:** We will use v18.14.2 for the official production client and server builds but feel free to use other NodeJS versions by setting "engine-strict=false" in the .npmrc file when working on localhost development as needed, but please use v18.14.2 when installing new modules. Do not commit the package.json or package-lock.json files should they change when "engine-strict=false".
16+
17+
### Core Libraries and Frameworks
18+
19+
- Client app
20+
- NextJS 13.2.4
21+
- React 18.2.0
22+
23+
## Installation
24+
25+
1. Clone this repository.<br>
26+
`https://github.com/weaponsforge/react-hooks-playground.git`
27+
28+
2. Follow the instructions on the README files inside the `/client` directory for more information on configuring and using the NextJS client app.
29+
530
@weaponsforge<br>
631
20230319

client/.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
engine-strict=true

client/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
18.14.2

client/README.md

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,45 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
## react-hooks-playground/client
22

3-
## Getting Started
3+
A React (NextJS) playground for testing using react hooks.
44

5-
First, run the development server:
5+
## Requirements
66

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
```
7+
The following dependecies are used for this project. Feel free to experiment using other dependencies and versions.
148

15-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
9+
1. Windows 64-bit OS
10+
2. nvm version 1.1.9 (for Windows)
11+
- NOTE: Using nvm is optional if you want to continue using your pre-installed NodeJS.
12+
3. NodeJS LTS v18.14.2 installed using nvm
13+
- node v18.14.2
14+
- npm v9.5.0
15+
- > **NOTE:** We will use v18.14.2 for the official production client and server builds but feel free to use other NodeJS versions by setting "engine-strict=false" in the .npmrc file when working on localhost development as needed, but please use v18.14.2 when installing new modules. Do not commit the package.json or package-lock.json files should they change when "engine-strict=false".
1616
17-
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
17+
### Core Libraries and Frameworks
1818

19-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
19+
- Client app
20+
- NextJS 13.2.4
21+
- React 18.2.0
2022

21-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
23+
## Installation
2224

23-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
25+
1. Clone this repository.<br>
26+
`https://github.com/weaponsforge/react-hooks-playground.git`
2427

25-
## Learn More
28+
## Available Scripts
2629

27-
To learn more about Next.js, take a look at the following resources:
30+
### `npm run dev`
31+
Run the project in development mode. Launch the development website from:<br>
32+
http://localhost:3000
2833

29-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
30-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
34+
### `npm run lint`
35+
Check for lint errors.
3136

32-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
37+
### `npm run export`
38+
Export the static website.
3339

34-
## Deploy on Vercel
40+
### `npm start`
41+
Load the static website built from npm run export (no hot reloads). View the built website on:<br>
42+
http://localhost:3000
3543

36-
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.
37-
38-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
44+
@weaponsforge<br>
45+
20230319

client/package-lock.json

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

client/package.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22
"name": "client",
33
"version": "0.1.0",
44
"private": true,
5+
"engines": {
6+
"node": "18.14.2",
7+
"npm": "9.5.0"
8+
},
59
"scripts": {
610
"dev": "next dev",
711
"build": "next build",
812
"start": "next start",
9-
"lint": "next lint"
13+
"lint": "next lint",
14+
"export": "npm run build && next export"
1015
},
1116
"dependencies": {
1217
"eslint": "8.36.0",

0 commit comments

Comments
 (0)