Skip to content

Commit a3c66c1

Browse files
authored
Merge pull request #254 from lirantal/master
docs: README file cleanup
2 parents e2dffdb + 76a4361 commit a3c66c1

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,19 @@
33
Being lightweight, fast, and scalable, Node.js is becoming a widely adopted platform for developing web applications. This project provides an environment to learn how OWASP Top 10 security risks apply to web applications developed using Node.js and how to effectively address them.
44

55
## Getting Started
6+
67
OWASP Top 10 for Node.js web applications:
78

89
### Know it!
10+
911
[Tutorial Guide](http://nodegoat.herokuapp.com/tutorial) explaining how each of the OWASP Top 10 vulnerabilities can manifest in Node.js web apps and how to prevent it.
1012

1113
### Do it!
14+
1215
[A Vulnerable Node.js App for Ninjas](http://nodegoat.herokuapp.com/) to exploit, toast, and fix. You may like to [set up your own copy](#how-to-set-up-your-copy-of-nodegoat) of the app to fix and test vulnerabilities. Hint: Look for comments in the source code.
16+
1317
##### Default user accounts
18+
1419
The database comes pre-populated with these user accounts created as part of the seed data -
1520
* Admin Account - u:admin p:Admin_123
1621
* User Accounts (u:user1 p:User1_123), (u:user2 p:User2_123)
@@ -73,11 +78,11 @@ The database comes pre-populated with these user accounts created as part of the
7378
```
7479
7580
#### Customizing the Default Application Configuration
81+
7682
By default the application will be hosted on port 4000 and will connect to a MongoDB instance at localhost:27017. To change this set the environment variables `PORT` and `MONGODB_URI`.
7783
7884
Other settings can be changed by updating the [config file](https://github.com/OWASP/NodeGoat/blob/master/config/env/all.js).
7985
80-
8186
### OPTION 2 - Run NodeGoat on Docker
8287
8388
The repo includes the Dockerfile and docker-compose.yml necessary to set up the app and db instance, then connect them together.
@@ -104,7 +109,6 @@ The repo includes the Dockerfile and docker-compose.yml necessary to set up the
104109
docker-compose up
105110
```
106111
107-
108112
### OPTION 3 - Deploy to Heroku
109113
110114
This option uses a free ($0/month) Heroku node server.
@@ -131,10 +135,9 @@ This will allow you to fix vulnerabilities in your own forked version, then depl
131135
The `<username>` and `<password>` fields need filling in with the details of the database user added earlier. The `<dbname>` field sets the name of the
132136
database nodegoat will use in the cluster (eg "nodegoat"). The other fields will already be filled in with the correct details for your cluster.
133137
134-
135138
## Report bugs, Feedback, Comments
136-
* Open a new [issue](https://github.com/OWASP/NodeGoat/issues) or contact team by joining chat at [Slack](https://owasp.slack.com/messages/project-nodegoat/) or [![Join the chat at https://gitter.im/OWASP/NodeGoat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/OWASP/NodeGoat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
137139
140+
* Open a new [issue](https://github.com/OWASP/NodeGoat/issues) or contact team by joining chat at [Slack](https://owasp.slack.com/messages/project-nodegoat/) or [![Join the chat at https://gitter.im/OWASP/NodeGoat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/OWASP/NodeGoat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
138141
139142
## Contributing
140143
@@ -145,10 +148,13 @@ Please Follow [the contributing guide](CONTRIBUTING.md)
145148
This project is bound by a [Code of Conduct](CODE_OF_CONDUCT.md).
146149
147150
## Contributors
151+
148152
Here are the amazing [contributors](https://github.com/OWASP/NodeGoat/graphs/contributors) to the NodeGoat project.
149153
150154
## Supports
155+
151156
- Thanks to JetBrains for providing licenses to fantastic [WebStorm IDE](https://www.jetbrains.com/webstorm/) to build this project.
152157
153158
## License
159+
154160
Code licensed under the [Apache License v2.0.](http://www.apache.org/licenses/LICENSE-2.0)

0 commit comments

Comments
 (0)