From 3a85ee116d2aef380036c4bd17bb757ecdc5344e Mon Sep 17 00:00:00 2001 From: mms37 Date: Sun, 19 Jun 2022 19:13:22 -0700 Subject: [PATCH] documentation --- README.md | 38 ++++++++++---------------------------- 1 file changed, 10 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 5f71935..7f8887e 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,4 @@ -# node-js-getting-started - -A barebones Node.js app using [Express 4](http://expressjs.com/). - -This application supports the [Getting Started on Heroku with Node.js](https://devcenter.heroku.com/articles/getting-started-with-nodejs) article - check it out. - -## Running Locally - -Make sure you have [Node.js](http://nodejs.org/) and the [Heroku CLI](https://cli.heroku.com/) installed. - -```sh -$ git clone https://github.com/heroku/node-js-getting-started.git # or clone your own fork -$ cd node-js-getting-started -$ npm install -$ npm start -``` - -Your app should now be running on [localhost:5000](http://localhost:5000/). - -## Deploying to Heroku +# Deploying to Heroku ``` $ heroku create @@ -28,12 +9,13 @@ or [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) -## Documentation - -For more information about using Node.js on Heroku, see these Dev Center articles: +# Documentation +## Add a student +Enter the data in the repected field and click on submit. The page will be updated to display all the student in the database. +## Edit student +Enter a valid student name from the the displayed list of students, an auto populated form will be displayed with the current data. Edit the details and press update. +## Delete a student +Enter a valid student name and press delete. -- [Getting Started on Heroku with Node.js](https://devcenter.heroku.com/articles/getting-started-with-nodejs) -- [Heroku Node.js Support](https://devcenter.heroku.com/articles/nodejs-support) -- [Node.js on Heroku](https://devcenter.heroku.com/categories/nodejs) -- [Best Practices for Node.js Development](https://devcenter.heroku.com/articles/node-best-practices) -- [Using WebSockets on Heroku with Node.js](https://devcenter.heroku.com/articles/node-websockets) +# Refrence +[node-js-getting-started](https://github.com/heroku/node-js-getting-started)