Updated readme for node web app (#261)

* updated readme * Review coments for readme update Co-authored-by: Anand Upadhyay <[email protected]>
microsoft · Aug 28, 2020 · 3271915 · 3271915
1 parent b20669f
commit 3271915
Show file tree

Hide file tree

Showing 12 changed files with 308 additions and 72 deletions.
diff --git a/github/node/express/webappCosmosDBWithTests/Application/README.md b/github/node/express/webappCosmosDBWithTests/Application/README.md
diff --git a/...bappCosmosDBWithTests/Application/LICENSE → ...e/express/webappCosmosDBWithTests/LICENSE b/...bappCosmosDBWithTests/Application/LICENSE → ...e/express/webappCosmosDBWithTests/LICENSE
diff --git a/github/node/express/webappCosmosDBWithTests/README.md b/github/node/express/webappCosmosDBWithTests/README.md
@@ -0,0 +1,77 @@
+# Nodejs Express web application
+
+Sample Nodejs Express web application built on [visual studio code](https://code.visualstudio.com/).
+
+Language| Framework | Runtime | Platform | Author |
+| --------| -------- | -------- |--------|--------|
+javascript| Express | node | Azure Web App| |
+
+## Installation
+
+For development, you will need Node.js and a node global package
+
+### Node
+- #### Node installation on Windows
+
+  Just go on [official Node.js website](https://nodejs.org/) and download the installer.
+Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
+
+- #### Node installation on Ubuntu
+
+  You can install nodejs and npm easily with apt install, just run the following commands.
+
+      $ sudo apt install nodejs
+      $ sudo apt install npm
+
+- #### Other Operating Systems
+  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/).
+
+If the installation was successful, you should be able to run the following command.
+
+    $ node --version
+    v8.11.3
+
+    $ npm --version
+    6.1.0
+
+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.
+
+    $ npm install npm -g
+
+## Running
+
+ - #### Clone this repository  
+
+```bash
+    $ git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
+```
+
+- #### Install dependencies
+```bash
+    $ cd Application
+    $ npm install -g
+```
+- #### Run Application
+```bash
+    $ cd Application
+    $ npm start
+```
+- #### Running tests
+```bash
+    $ cd Tests
+    $ npm install -g
+    $ npm test
+```
+
+## Deploying on Azure
+
+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).
+
+## Contributing
+
+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.
+
+
+## License:
+
+See [LICENSE](LICENSE).
diff --git a/github/node/express/webappWithTests/Application/README.md b/github/node/express/webappWithTests/Application/README.md
diff --git a/...press/webappWithTests/Application/LICENSE → github/node/express/webappWithTests/LICENSE b/...press/webappWithTests/Application/LICENSE → github/node/express/webappWithTests/LICENSE
diff --git a/github/node/express/webappWithTests/README.md b/github/node/express/webappWithTests/README.md
@@ -0,0 +1,77 @@
+# Nodejs Express web application
+
+Sample Nodejs Express web application built on [visual studio code](https://code.visualstudio.com/).
+
+Language| Framework | Runtime | Platform | Author |
+| --------| -------- | -------- |--------|--------|
+javascript| Express | node | Azure Web App| |
+
+## Installation
+
+For development, you will need Node.js and a node global package
+
+### Node
+- #### Node installation on Windows
+
+  Just go on [official Node.js website](https://nodejs.org/) and download the installer.
+Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
+
+- #### Node installation on Ubuntu
+
+  You can install nodejs and npm easily with apt install, just run the following commands.
+
+      $ sudo apt install nodejs
+      $ sudo apt install npm
+
+- #### Other Operating Systems
+  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/).
+
+If the installation was successful, you should be able to run the following command.
+
+    $ node --version
+    v8.11.3
+
+    $ npm --version
+    6.1.0
+
+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.
+
+    $ npm install npm -g
+
+## Running
+
+ - #### Clone this repository  
+
+```bash
+    $ git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
+```
+
+- #### Install dependencies
+```bash
+    $ cd Application
+    $ npm install -g
+```
+- #### Run Application
+```bash
+    $ cd Application
+    $ npm start
+```
+- #### Running tests
+```bash
+    $ cd Tests
+    $ npm install -g
+    $ npm test
+```
+
+## Deploying on Azure
+
+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).
+
+## Contributing
+
+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.
+
+
+## License:
+
+See [LICENSE](LICENSE).
diff --git a/github/node/plain/webappCosmosDBWithTests/Application/README.md b/github/node/plain/webappCosmosDBWithTests/Application/README.md
diff --git a/...bappCosmosDBWithTests/Application/LICENSE → ...ode/plain/webappCosmosDBWithTests/LICENSE b/...bappCosmosDBWithTests/Application/LICENSE → ...ode/plain/webappCosmosDBWithTests/LICENSE
diff --git a/github/node/plain/webappCosmosDBWithTests/README.md b/github/node/plain/webappCosmosDBWithTests/README.md
@@ -0,0 +1,77 @@
+# Nodejs web application
+
+Sample Nodejs web application built on [visual studio code](https://code.visualstudio.com/).
+
+Language| Framework | Runtime | Platform | Author |
+| --------| -------- | -------- |--------|--------|
+javascript| simple node js | node | Azure Web App| |
+
+## Installation
+
+For development, you will need Node.js and a node global package
+
+### Node
+- #### Node installation on Windows
+
+  Just go on [official Node.js website](https://nodejs.org/) and download the installer.
+Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
+
+- #### Node installation on Ubuntu
+
+  You can install nodejs and npm easily with apt install, just run the following commands.
+
+      $ sudo apt install nodejs
+      $ sudo apt install npm
+
+- #### Other Operating Systems
+  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/).
+
+If the installation was successful, you should be able to run the following command.
+
+    $ node --version
+    v8.11.3
+
+    $ npm --version
+    6.1.0
+
+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.
+
+    $ npm install npm -g
+
+## Running
+
+ - #### Clone this repository  
+
+```bash
+    $ git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
+```
+
+- #### Install dependencies
+```bash
+    $ cd Application
+    $ npm install -g
+```
+- #### Run Application
+```bash
+    $ cd Application
+    $ npm start
+```
+- #### Running tests
+```bash
+    $ cd Tests
+    $ npm install -g
+    $ npm test
+```
+
+## Deploying on Azure
+
+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).
+
+## Contributing
+
+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.
+
+
+## License:
+
+See [LICENSE](LICENSE).
diff --git a/github/node/plain/webappWithTests/Application/README.md b/github/node/plain/webappWithTests/Application/README.md
diff --git a/...plain/webappWithTests/Application/LICENSE → github/node/plain/webappWithTests/LICENSE b/...plain/webappWithTests/Application/LICENSE → github/node/plain/webappWithTests/LICENSE
diff --git a/github/node/plain/webappWithTests/README.md b/github/node/plain/webappWithTests/README.md
@@ -0,0 +1,77 @@
+# Nodejs web application
+
+Sample Nodejs web application built on [visual studio code](https://code.visualstudio.com/).
+
+Language| Framework | Runtime | Platform | Author |
+| --------| -------- | -------- |--------|--------|
+javascript| simple node js | node | Azure Web App| |
+
+## Installation
+
+For development, you will need Node.js and a node global package
+
+### Node
+- #### Node installation on Windows
+
+  Just go on [official Node.js website](https://nodejs.org/) and download the installer.
+Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
+
+- #### Node installation on Ubuntu
+
+  You can install nodejs and npm easily with apt install, just run the following commands.
+
+      $ sudo apt install nodejs
+      $ sudo apt install npm
+
+- #### Other Operating Systems
+  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/).
+
+If the installation was successful, you should be able to run the following command.
+
+    $ node --version
+    v8.11.3
+
+    $ npm --version
+    6.1.0
+
+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.
+
+    $ npm install npm -g
+
+## Running
+
+ - #### Clone this repository  
+
+```bash
+    $ git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
+```
+
+- #### Install dependencies
+```bash
+    $ cd Application
+    $ npm install -g
+```
+- #### Run Application
+```bash
+    $ cd Application
+    $ npm start
+```
+- #### Running tests
+```bash
+    $ cd Tests
+    $ npm install -g
+    $ npm test
+```
+
+## Deploying on Azure
+
+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).
+
+## Contributing
+
+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.
+
+
+## License:
+
+See [LICENSE](LICENSE).