Open platform to collect and prioritize feedback
update readme (#99)
Guilherme Oenning1b71711ec0a9
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 000000000..6d182faf1--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,28 @@+# How to run it locally for development purpose?++Fider is mainly written in Go and TypeScript, but we're also using things like Node.js, React and PostgreSQL.+If you know these technologies or would like to learn them, lucky you! This is the right place!++Tools you'll need:++- Go 1.8+ (https://golang.org)+- Node.js 6+ (https://nodejs.org/)+- Docker (https://www.docker.com/)+- github.com/codegangsta/gin (https://github.com/codegangsta/gin)++Step by step:++1) clone this repository into `$GOPATH/src/github.com/getfider/fider`+2) run `npm install` to install front end packages+3) run `npm run build:watch` to pack the front end source into a bundle. It'll+4) run `docker-compose up -d pgdev` to start a local PostgreSQL database on Docker.+5) run `cp .example.env .env` to create a local Environment configuration file.+6) run `make watch` to start the application.+7) Navigate to `http://localhost:3000/` and boom! Welcome to your new local Fider development copy!++Change some code, fix some bugs, implement some features and send us your Pull Request!++# How to run the tests++1) run `docker-compose up -d pgtest` to start a test-only PostgreSQL database on Docker.+2) run `make test`.diff --git a/README.md b/README.mdindex 630a5d228..c32da0aed 100644--- a/README.md+++ b/README.md@@ -13,31 +13,6 @@ If you have a suggestion on how to make Fider better, please [share with us](htt-# How to run it locally for development purpose?+# Want to contribute?-Fider is mainly written in Go and TypeScript, but we're also using things like Node.js, React and PostgreSQL.-If you know these technologies or would like to learn them, lucky you! This is the right place!--Tools you'll need:--- Go 1.8+ (https://golang.org)-- Node.js 6+ (https://nodejs.org/)-- Docker (https://www.docker.com/)-- github.com/codegangsta/gin (https://github.com/codegangsta/gin)--Step by step:--1) clone this repository into `$GOPATH/src/github.com/getfider/fider`-2) run `npm install` to install front end packages-3) run `npm run build:watch` to pack the front end source into a bundle. It'll-4) run `docker-compose up -d pgdev` to start a local PostgreSQL database on Docker.-5) run `cp .example.env .env` to create a local Environment configuration file.-6) run `make watch` to start the application.-7) Navigate to `http://localhost:3000/` and boom! Welcome to your new local Fider development copy!--Change some code, fix some bugs, implement some features and send us your Pull Request!--# How to run the tests--1) run `docker-compose up -d pgtest` to start a test-only PostgreSQL database on Docker.-2) run `make test`.+Read how to configure a development environment at [CONTRIBUTING.md](CONTRIBUTING.md).\ No newline at end of filediff --git a/docs/homepage.png b/docs/homepage.pngindex 39d5d0fb6..965050e7b 100644Binary files a/docs/homepage.png and b/docs/homepage.png differ