Skip to content

Commit a726d13

Browse files
fxedelFloEdelmann
authored andcommitted
Improved README.md
Added `npm install` and rearranged some content
1 parent 608cc26 commit a726d13

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@ This is still in a very, very early stage. But you can still see the current dep
44

55
## Contribute
66

7-
Every push to the `master` branch here on GitHub deploys a new version. So we have to make sure that the `master` branch is always clean and ready to deploy. Thus, we will make heavy use of pull requests (so, do always create feature branches `git checkout -b new-feature`) and let [Travis CI](https://travis-ci.org/FloEdelmann/open-fixture-library) check that everything new is passing all tests.
7+
Pushing to the `master` branch here on GitHub deploys a new version each time. So we have to make sure that the `master` branch is always clean and ready to deploy. Thus, we will make heavy use of pull requests (so, do always create feature branches `git checkout -b new-feature`) and let [Travis CI](https://travis-ci.org/FloEdelmann/open-fixture-library) check that everything new is passing all tests.
88

9-
Locally, you can test every change by running `node index.js` (or `heroku local`, which lets you use environment variables in the `.env` file) and opening [localhost:5000](http://localhost:5000/).
9+
Every contribution is welcome, even in this early stage!
1010

11-
Every contribution is welcome, even in this early stage!
11+
### Local installation
12+
13+
1. Clone this repository (or a fork of it).
14+
2. Run `npm install` after first cloning or every time new dependencies are added in [package.json](package.json) in order to install the needed Node dependencies. (You can identify missing dependencies when the error "Cannot find module" is given.)
15+
3. To start the server locally at [localhost:5000](http://localhost:5000/), run `node index.js` (or `heroku local`, which lets you use environment variables in the `.env` file).

0 commit comments

Comments
 (0)