[readme] add development setup help;

Benjamin Bouvier 5 years ago
parent 63e7c09870
commit f2d79a4309

@ -3,13 +3,38 @@
# Eventos
To start your Phoenix server:
## Development
* Install dependencies with `mix deps.get`
* Create and migrate your database with `mix ecto.create && mix ecto.migrate`
* Start Phoenix endpoint with `mix phx.server`
### Server
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
* Start postgres and make sure the postgis extension is installed.
* Create a postgres user with database creation capabilities, using the
following: `createuser -d -P elixir` and set `elixir` as the password.
* Fetch dependencies with `mix deps.get`.
* Create your database with `mix ecto.create`.
* Create the postgis extension on the database with a postgres user that has
superuser capabilities: `psql eventos_dev`
``` create extension if not exists postgis; ```
* Run migrations: `mix ecto.migrate`.
* Start Phoenix endpoint with `mix phx.server`.
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser
and see the website (server *and* client) in action.
### Client
If you plan to specifically change the client side (frontend), do the following
once the server is running:
* Change directory to `js/`.
* Install JavaScript package dependencies: `npm install`.
* Run the developement server in watch mode: `npm run dev`. This will open a
browser on [`localhost:8080`](http://localhost:8080) that gets
automatically reloaded on change.
## Production
Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment).