Update introduction

Luka Murn 2018-06-02 10:01:46 +02:00
parent adcb015a87
commit 7120f93efd

@ -15,13 +15,14 @@ The following are minimal steps needed to start SciNote in development environme
1. Clone this Git repository onto your development machine.
2. Create a file `config/application.yml`. Populate it with mandatory environmental variables (see [environmental variables](#user-content-environmental-variables)).
3. In SciNote folder, run the following command: `make docker`. This can take a while, since Docker must first pull an image from the Internet, and then also install all neccesary Gems required by SciNote.
4. Once the Docker image is created, run `make cli` command. Once inside the running Docker container, run the following commands: `rake db:create` - `rake db:migrate` - `rake db:seed`. This should initialize the database and fill it with (very minimal) seed data.
4. Once the Docker image is created, run `make run` command. This will install all the required Gems, and spin-off a (not-yet-working) server.
4. Once all Gems are installed, and server starts, stop it (`Ctrl + C`). Run `make cli` command. Once inside the running Docker container, run the following commands: `rake db:drop` - `rake db:create` - `rake db:migrate` - `rake db:seed`. This should initialize the database and fill it with (very minimal) seed data.
5. Exit the Docker container by typing `exit`.
6. To start the server, run command `make run`. Wait until the server starts listening on port `3000`.
7. Inside another CLI window (also from SciNote folder), run command `make worker`. This command should start the background worker process which is used by SciNote for a lot of demanding tasks.
8. Open your favourite browser and navigate to [http://localhost:3000](http://localhost:3000/). Use the seeded administrator account from [seeds.rb](https://github.com/biosistemika/scinote-web/blob/master/db/seeds.rb) to login, or sign up for a new account.
8. Open your favourite browser and navigate to [http://localhost:3000](http://localhost:3000/). Use the seeded administrator account from [seeds.rb](https://github.com/biosistemika/scinote-web/blob/master/db/seeds.rb) (or account set up using [environmental variables](../Environmental-variables)) to login, or sign up for a new account.
If you need to run server in production please check [this section](#running-inside-docker-containers-in-production-mode-with-docker-compose)
If you need to run server in production please check [this section](#running-inside-docker-containers-in-production-mode-with-docker-compose).
### OS-specific Install Instructions