appropriate readme
This commit is contained in:
parent
9a7ca8c326
commit
5560461058
1 changed files with 4 additions and 39 deletions
43
README.md
43
README.md
|
|
@ -1,39 +1,4 @@
|
||||||
# node-js-getting-started
|
* simple traffic light application (in Dutch) to store ratings ('happy', 'unsure', 'unhappy') for a user
|
||||||
|
* stores data in local csv file
|
||||||
A barebones Node.js app using [Express 4](http://expressjs.com/).
|
* logins are hardcoded (using bcrypt)
|
||||||
|
|
||||||
This application supports the [Getting Started with Node on Heroku](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
|
|
||||||
|
|
||||||
```
|
|
||||||
$ heroku create
|
|
||||||
$ git push heroku master
|
|
||||||
$ heroku open
|
|
||||||
```
|
|
||||||
or
|
|
||||||
|
|
||||||
[](https://heroku.com/deploy)
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
For more information about using Node.js on Heroku, see these Dev Center articles:
|
|
||||||
|
|
||||||
- [Getting Started with Node.js on Heroku](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)
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue