Permalink
Browse files

Add development guide to contributing section

  • Loading branch information...
seadowg committed Oct 12, 2018
1 parent 6028c51 commit 53d30d630cd7fc328b825dd9a7f76eb859108717
Showing with 65 additions and 65 deletions.
  1. +65 −0 CONTRIBUTING.md
  2. +0 −65 README.md
@@ -1,3 +1,68 @@
# Development Environment
## Dependencies
* Ruby 2.4.0
* bundler
* rspec
* Node 6
* npm 3.10.10 (`npm install -g npm@3.10.10`)
* gulp
* chromedriver
To avoid having to install and manage these dependencies you can use the Postfacto [docker image](https://hub.docker.com/r/postfacto/postfacto/) for development.
## Installing library dependencies
Before development you'll need to install library dependencies (gems and npm packages) for the `web`, `api` and `e2e` codebases by running:
```bash
./deps.sh
```
## Running locally
You can run Postfacto locally at [http://localhost:3000]() by running:
```bash
./run.sh
```
The admin dashboard will be available at [http://localhost:4000/admin](). You can create an admin user using the following rake task in the `api` directory:
```bash
ADMIN_EMAIL=email@example.com ADMIN_PASSWORD=password rake admin:create_user
```
## Running tests
You can run the tests for the whole project in the root directory by simply running:
```bash
./test.sh
```
### Web
```bash
cd web
gulp spec-app
```
### API
```bash
cd api
bundle exec rake
```
### End to end
```bash
cd web
gulp local-acceptance
```
# Contributing to Pivotal Projects
We’d love to accept your patches and contributions to this project. Please review the following guidelines you'll need to follow in order to make a contribution.
@@ -34,71 +34,6 @@ You can [deploy](#deployment) your own Postfacto to **Pivotal Web Services** or
Download the [latest release](https://github.com/pivotal/postfacto/releases) and follow the included instructions on deploying your own instance of Postfacto.
## Development
### Dependencies
* Ruby 2.4.0
* bundler
* rspec
* Node 6
* npm 3.10.10 (`npm install -g npm@3.10.10`)
* gulp
* chromedriver
To avoid having to install and manage these dependencies you can use the Postfacto [docker image](https://hub.docker.com/r/postfacto/postfacto/) for development.
### Installing library dependencies
Before development you'll need to install library dependencies (gems and npm packages) for the `web`, `api` and `e2e` codebases by running:
```bash
./deps.sh
```
### Running locally
You can run Postfacto locally at [http://localhost:3000]() by running:
```bash
./run.sh
```
The admin dashboard will be available at [http://localhost:4000/admin](). You can create an admin user using the following rake task in the `api` directory:
```bash
ADMIN_EMAIL=email@example.com ADMIN_PASSWORD=password rake admin:create_user
```
### Running tests
You can run the tests for the whole project in the root directory by simply running:
```bash
./test.sh
```
#### Web
```bash
cd web
gulp spec-app
```
#### API
```bash
cd api
bundle exec rake
```
#### End to end
```bash
cd web
gulp local-acceptance
```
## Contributing
See our [Contributing Guide](CONTRIBUTING.md).

0 comments on commit 53d30d6

Please sign in to comment.