From b036e7b078d98cf225ec32123e3bcac9a957a61b Mon Sep 17 00:00:00 2001 From: Flavio Granero Date: Fri, 24 Apr 2015 10:26:59 -0300 Subject: [PATCH] updating README instructions --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb72976..881cee8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ # Plixir -To start your new Phoenix application: +Plixir is built using [Phoenix Framework](http://www.phoenixframework.org/) and [Ecto](https://github.com/elixir-lang/ecto) accessing a PostgreSQL database. + +To start your Plixir application, you have to: 1. Install dependencies with `mix deps.get` -2. Start Phoenix endpoint with `mix phoenix.server` +2. Run `npm install` to install javascript dependencies +3. Make sure you have a 'plixir' role in your Postgres + CREATE USER plixir WITH PASSWORD 'plixir' CREATEDB; +4. Run Ecto migrations with `mix do ecto.create, ecto.migrate` +5. Start Phoenix endpoint with `mix phoenix.server` Now you can visit `localhost:4000` from your browser.