Skip to content
This repository was archived by the owner on Jun 14, 2024. It is now read-only.

Commit 3271915

Browse files
upadhyayapAnand Upadhyay
andauthored
Updated readme for node web app (#261)
* updated readme * Review coments for readme update Co-authored-by: Anand Upadhyay <[email protected]>
1 parent b20669f commit 3271915

File tree

12 files changed

+308
-72
lines changed

12 files changed

+308
-72
lines changed

github/node/express/webappCosmosDBWithTests/Application/README.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Nodejs Express web application
2+
3+
Sample Nodejs Express web application built on [visual studio code](https://code.visualstudio.com/).
4+
5+
Language| Framework | Runtime | Platform | Author |
6+
| --------| -------- | -------- |--------|--------|
7+
javascript| Express | node | Azure Web App| |
8+
9+
## Installation
10+
11+
For development, you will need Node.js and a node global package
12+
13+
### Node
14+
- #### Node installation on Windows
15+
16+
Just go on [official Node.js website](https://nodejs.org/) and download the installer.
17+
Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
18+
19+
- #### Node installation on Ubuntu
20+
21+
You can install nodejs and npm easily with apt install, just run the following commands.
22+
23+
$ sudo apt install nodejs
24+
$ sudo apt install npm
25+
26+
- #### Other Operating Systems
27+
You can find more information about the installation on the [official Node.js website](https://nodejs.org/) and the [official NPM website](https://npmjs.org/).
28+
29+
If the installation was successful, you should be able to run the following command.
30+
31+
$ node --version
32+
v8.11.3
33+
34+
$ npm --version
35+
6.1.0
36+
37+
If you need to update `npm`, you can make it using `npm`! Cool right? After running the following command, just open again the command line and be happy.
38+
39+
$ npm install npm -g
40+
41+
## Running
42+
43+
- #### Clone this repository
44+
45+
```bash
46+
$ git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
47+
```
48+
49+
- #### Install dependencies
50+
```bash
51+
$ cd Application
52+
$ npm install -g
53+
```
54+
- #### Run Application
55+
```bash
56+
$ cd Application
57+
$ npm start
58+
```
59+
- #### Running tests
60+
```bash
61+
$ cd Tests
62+
$ npm install -g
63+
$ npm test
64+
```
65+
66+
## Deploying on Azure
67+
68+
Any change to this repository will result in triggering a workflow to build and deploy this app on azure as an app service. Learn more about [Azure App Service](https://docs.microsoft.com/en-us/azure/app-service/) and [Github Actions](https://docs.github.com/en/actions).
69+
70+
## Contributing
71+
72+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
73+
74+
75+
## License:
76+
77+
See [LICENSE](LICENSE).

github/node/express/webappWithTests/Application/README.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Nodejs Express web application
2+
3+
Sample Nodejs Express web application built on [visual studio code](https://code.visualstudio.com/).
4+
5+
Language| Framework | Runtime | Platform | Author |
6+
| --------| -------- | -------- |--------|--------|
7+
javascript| Express | node | Azure Web App| |
8+
9+
## Installation
10+
11+
For development, you will need Node.js and a node global package
12+
13+
### Node
14+
- #### Node installation on Windows
15+
16+
Just go on [official Node.js website](https://nodejs.org/) and download the installer.
17+
Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
18+
19+
- #### Node installation on Ubuntu
20+
21+
You can install nodejs and npm easily with apt install, just run the following commands.
22+
23+
$ sudo apt install nodejs
24+
$ sudo apt install npm
25+
26+
- #### Other Operating Systems
27+
You can find more information about the installation on the [official Node.js website](https://nodejs.org/) and the [official NPM website](https://npmjs.org/).
28+
29+
If the installation was successful, you should be able to run the following command.
30+
31+
$ node --version
32+
v8.11.3
33+
34+
$ npm --version
35+
6.1.0
36+
37+
If you need to update `npm`, you can make it using `npm`! Cool right? After running the following command, just open again the command line and be happy.
38+
39+
$ npm install npm -g
40+
41+
## Running
42+
43+
- #### Clone this repository
44+
45+
```bash
46+
$ git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
47+
```
48+
49+
- #### Install dependencies
50+
```bash
51+
$ cd Application
52+
$ npm install -g
53+
```
54+
- #### Run Application
55+
```bash
56+
$ cd Application
57+
$ npm start
58+
```
59+
- #### Running tests
60+
```bash
61+
$ cd Tests
62+
$ npm install -g
63+
$ npm test
64+
```
65+
66+
## Deploying on Azure
67+
68+
Any change to this repository will result in triggering a workflow to build and deploy this app on azure as an app service. Learn more about [Azure App Service](https://docs.microsoft.com/en-us/azure/app-service/) and [Github Actions](https://docs.github.com/en/actions).
69+
70+
## Contributing
71+
72+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
73+
74+
75+
## License:
76+
77+
See [LICENSE](LICENSE).

github/node/plain/webappCosmosDBWithTests/Application/README.md

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Nodejs web application
2+
3+
Sample Nodejs web application built on [visual studio code](https://code.visualstudio.com/).
4+
5+
Language| Framework | Runtime | Platform | Author |
6+
| --------| -------- | -------- |--------|--------|
7+
javascript| simple node js | node | Azure Web App| |
8+
9+
## Installation
10+
11+
For development, you will need Node.js and a node global package
12+
13+
### Node
14+
- #### Node installation on Windows
15+
16+
Just go on [official Node.js website](https://nodejs.org/) and download the installer.
17+
Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
18+
19+
- #### Node installation on Ubuntu
20+
21+
You can install nodejs and npm easily with apt install, just run the following commands.
22+
23+
$ sudo apt install nodejs
24+
$ sudo apt install npm
25+
26+
- #### Other Operating Systems
27+
You can find more information about the installation on the [official Node.js website](https://nodejs.org/) and the [official NPM website](https://npmjs.org/).
28+
29+
If the installation was successful, you should be able to run the following command.
30+
31+
$ node --version
32+
v8.11.3
33+
34+
$ npm --version
35+
6.1.0
36+
37+
If you need to update `npm`, you can make it using `npm`! Cool right? After running the following command, just open again the command line and be happy.
38+
39+
$ npm install npm -g
40+
41+
## Running
42+
43+
- #### Clone this repository
44+
45+
```bash
46+
$ git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
47+
```
48+
49+
- #### Install dependencies
50+
```bash
51+
$ cd Application
52+
$ npm install -g
53+
```
54+
- #### Run Application
55+
```bash
56+
$ cd Application
57+
$ npm start
58+
```
59+
- #### Running tests
60+
```bash
61+
$ cd Tests
62+
$ npm install -g
63+
$ npm test
64+
```
65+
66+
## Deploying on Azure
67+
68+
Any change to this repository will result in triggering a workflow to build and deploy this app on azure as an app service. Learn more about [Azure App Service](https://docs.microsoft.com/en-us/azure/app-service/) and [Github Actions](https://docs.github.com/en/actions).
69+
70+
## Contributing
71+
72+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
73+
74+
75+
## License:
76+
77+
See [LICENSE](LICENSE).

github/node/plain/webappWithTests/Application/README.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)