Skip to content

Commit

Permalink
Improved README.md
Browse files Browse the repository at this point in the history
Added `npm install` and rearranged some content
  • Loading branch information
fxedel authored and FloEdelmann committed Feb 25, 2017
1 parent 608cc26 commit a726d13
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ This is still in a very, very early stage. But you can still see the current dep

## Contribute

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.
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.

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/).
Every contribution is welcome, even in this early stage!

Every contribution is welcome, even in this early stage!
### Local installation

1. Clone this repository (or a fork of it).
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.)
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 comments on commit a726d13

Please sign in to comment.