From 32719153df595943bea56e19d5aff5db7f63b279 Mon Sep 17 00:00:00 2001 From: Anand Upadhyay Date: Fri, 28 Aug 2020 12:17:59 +0530 Subject: [PATCH] Updated readme for node web app (#261) * updated readme * Review coments for readme update Co-authored-by: Anand Upadhyay --- .../Application/README.md | 17 ---- .../{Application => }/LICENSE | 0 .../express/webappCosmosDBWithTests/README.md | 77 +++++++++++++++++++ .../webappWithTests/Application/README.md | 17 ---- .../webappWithTests/{Application => }/LICENSE | 0 github/node/express/webappWithTests/README.md | 77 +++++++++++++++++++ .../Application/README.md | 19 ----- .../{Application => }/LICENSE | 0 .../plain/webappCosmosDBWithTests/README.md | 77 +++++++++++++++++++ .../webappWithTests/Application/README.md | 19 ----- .../webappWithTests/{Application => }/LICENSE | 0 github/node/plain/webappWithTests/README.md | 77 +++++++++++++++++++ 12 files changed, 308 insertions(+), 72 deletions(-) delete mode 100644 github/node/express/webappCosmosDBWithTests/Application/README.md rename github/node/express/webappCosmosDBWithTests/{Application => }/LICENSE (100%) create mode 100644 github/node/express/webappCosmosDBWithTests/README.md delete mode 100644 github/node/express/webappWithTests/Application/README.md rename github/node/express/webappWithTests/{Application => }/LICENSE (100%) create mode 100644 github/node/express/webappWithTests/README.md delete mode 100644 github/node/plain/webappCosmosDBWithTests/Application/README.md rename github/node/plain/webappCosmosDBWithTests/{Application => }/LICENSE (100%) create mode 100644 github/node/plain/webappCosmosDBWithTests/README.md delete mode 100644 github/node/plain/webappWithTests/Application/README.md rename github/node/plain/webappWithTests/{Application => }/LICENSE (100%) create mode 100644 github/node/plain/webappWithTests/README.md diff --git a/github/node/express/webappCosmosDBWithTests/Application/README.md b/github/node/express/webappCosmosDBWithTests/Application/README.md deleted file mode 100644 index 8ac158db2..000000000 --- a/github/node/express/webappCosmosDBWithTests/Application/README.md +++ /dev/null @@ -1,17 +0,0 @@ -| Language | Framework | Platform | Author | -| -------- | -------- |--------|--------| -| Nodejs | Express | Azure Web App, Virtual Machine| | - - -# Nodejs Express web application - -Sample Nodejs Express web application built using Visual Studio 2017. - -## License: - -See [LICENSE](LICENSE). - -## 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. - diff --git a/github/node/express/webappCosmosDBWithTests/Application/LICENSE b/github/node/express/webappCosmosDBWithTests/LICENSE similarity index 100% rename from github/node/express/webappCosmosDBWithTests/Application/LICENSE rename to github/node/express/webappCosmosDBWithTests/LICENSE diff --git a/github/node/express/webappCosmosDBWithTests/README.md b/github/node/express/webappCosmosDBWithTests/README.md new file mode 100644 index 000000000..5f0176518 --- /dev/null +++ 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) 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 deleted file mode 100644 index 8ac158db2..000000000 --- a/github/node/express/webappWithTests/Application/README.md +++ /dev/null @@ -1,17 +0,0 @@ -| Language | Framework | Platform | Author | -| -------- | -------- |--------|--------| -| Nodejs | Express | Azure Web App, Virtual Machine| | - - -# Nodejs Express web application - -Sample Nodejs Express web application built using Visual Studio 2017. - -## License: - -See [LICENSE](LICENSE). - -## 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. - diff --git a/github/node/express/webappWithTests/Application/LICENSE b/github/node/express/webappWithTests/LICENSE similarity index 100% rename from github/node/express/webappWithTests/Application/LICENSE rename to github/node/express/webappWithTests/LICENSE diff --git a/github/node/express/webappWithTests/README.md b/github/node/express/webappWithTests/README.md new file mode 100644 index 000000000..5f0176518 --- /dev/null +++ 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) 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 deleted file mode 100644 index d9cadd3b4..000000000 --- a/github/node/plain/webappCosmosDBWithTests/Application/README.md +++ /dev/null @@ -1,19 +0,0 @@ -| Language | Framework | Platform | Author | -| -------- | -------- |--------|--------| -| Nodejs | | Azure Web App, Virtual Machine| | - - -# Nodejs web application - -Sample Nodejs web application built using Visual Studio 2017. - -## License - -See [LICENSE](LICENSE). - -## 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. - - - diff --git a/github/node/plain/webappCosmosDBWithTests/Application/LICENSE b/github/node/plain/webappCosmosDBWithTests/LICENSE similarity index 100% rename from github/node/plain/webappCosmosDBWithTests/Application/LICENSE rename to github/node/plain/webappCosmosDBWithTests/LICENSE diff --git a/github/node/plain/webappCosmosDBWithTests/README.md b/github/node/plain/webappCosmosDBWithTests/README.md new file mode 100644 index 000000000..df1ed6b02 --- /dev/null +++ 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) 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 deleted file mode 100644 index d9cadd3b4..000000000 --- a/github/node/plain/webappWithTests/Application/README.md +++ /dev/null @@ -1,19 +0,0 @@ -| Language | Framework | Platform | Author | -| -------- | -------- |--------|--------| -| Nodejs | | Azure Web App, Virtual Machine| | - - -# Nodejs web application - -Sample Nodejs web application built using Visual Studio 2017. - -## License - -See [LICENSE](LICENSE). - -## 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. - - - diff --git a/github/node/plain/webappWithTests/Application/LICENSE b/github/node/plain/webappWithTests/LICENSE similarity index 100% rename from github/node/plain/webappWithTests/Application/LICENSE rename to github/node/plain/webappWithTests/LICENSE diff --git a/github/node/plain/webappWithTests/README.md b/github/node/plain/webappWithTests/README.md new file mode 100644 index 000000000..df1ed6b02 --- /dev/null +++ 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + +## License: + +See [LICENSE](LICENSE).