Merged PR 338: updated installation readme 2

updated installation readme 2

Related work items: #5159
This commit is contained in:
Robert Bond
2021-07-01 12:09:28 +00:00
+48 -16
View File
@@ -1,4 +1,48 @@
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).
## Setting up environment
These instructions assumes that you already have Git installed and working
You will need to install NodeJs [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
If you have necessary installation privileges
- download and run the installer version
If you dont have privileges
- download the zip archive
- extract the folder to your environment
- Add the path to this folder in to your PATH Environment Variable
- verify installation by opening a new terminal window and do the following
```bash
node -v
```
- verify npm by typing the following
```bash
npm -v
```
Next, Clone the repository from Azure DevOps to a relevant folder
Open a terminal window to this folder and install the packages needed:
```bash
npm install
```
if there is an error message regarding access via the proxy
```bash
npm config set proxy "http://domain\username:password@servername:port/"
```
or unable to get packages try the following:
```bash
npm config set registry "http://registry.npmjs.org/"
```
## Getting Started
@@ -12,23 +56,11 @@ yarn dev
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
[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`.
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.
Note: there may be a firewall message pop up.....
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
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.
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.