Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 2.06 KB

quickstart.md

File metadata and controls

55 lines (44 loc) · 2.06 KB

Loomio Development Quickstart

Clone the Loomio repo from github

git clone [email protected]:loomio/loomio.git && cd loomio

Create database user

On OSX

If you're on OSX then you can run the following bootstrap task to setup your system with postgresql, npm, bundler and gulp. It will then create an admin user. If you need help installing ruby, or more detail on installing the dependencies, please read Setup Environment

If you are setting up with PostgreSQL for the first time, you would have to create a superuser.

[sudo] su postgres -c 'createuser -P --superuser <username>'

On Linux

If running Linux, you'll use:

$ sudo -u postgres psql postgres
postgres=# CREATE USER <youruseraccount> WITH SUPERUSER;
\q
$ logout

Run the bootstrap task

rake bootstrap

NB: Take note of the email and password generated at the end of this task; you'll need it to log in once setup is complete

Build the angular frontend

cd angular && gulp compile

Launch the server

rails s

Other things to know

  • There are several other gulp commands you can run to make your development go. These can be run from the angular folder.
    • gulp dev: Automatically rebuild the javascript app as you make changes. If you feel like your changes aren't being picked up, try restarting this process.
    • gulp protractor: Run the automated frontend tests
    • gulp protractor:now: Rebuild the javascript app, then run the automated frontend tests
    • PRIVATE_PUB_SECRET_TOKEN=abc123 bundle exec rackup private_pub.ru -E production is how to start faye (live updating) in development
    • npm rebuild node-sass has been known to be very useful
    • if you ever get into problems, then rm -rf node_modules && yarn

Having trouble?