1
0
mirror of https://github.com/fazo96/ipfs-boards synced 2025-01-10 12:24:20 +01:00
ipfs-boards/CONTRIBUTING.md

27 lines
972 B
Markdown
Raw Permalink Normal View History

2015-11-15 21:34:22 +01:00
## Setting up a developer environment
You'll need:
- __node and npm__: you can get these on Homebrew on OSX or in your Linux distro's repos
- __git__: you can get it just like node and npm
- __gulp__: you can get it by running `npm install -g gulp`. It might require super user privileges
- __go-ipfs__: you can get it like git and node, but not always, you may need to follow its istructions on its repo
1. Clone this repository and `cd` to its directory
1. run `npm install` to get dependences (there are many)
To use the app you'll need to have an IPFS daemon running. You can start one using `ipfs daemon`
You will also need to enable CORS on your IPFS daemon. See or run the `ipfs_daemon_set_cors.sh` file
Now you can run:
- `gulp` to build the webapp inside `webapp/dist/`
- `gulp serve` to start a webserver that will serve you the app and rebuild it if you change some files
Have fun!
2015-12-04 11:07:19 +01:00
### Contributing a pull request
Make sure your code compiles fine :)