diff --git a/Build-&-run.md b/Build-&-run.md index f0be963..0e4d0b9 100644 --- a/Build-&-run.md +++ b/Build-&-run.md @@ -30,6 +30,8 @@ git clone https://github.com/biosistemika/scinote-web.git #### 2. Configure the server + + To setup the basic configuration of SciNote server, create a file `config/application.yml` in the root SciNote directory. Populate it with mandatory environmental variables, as described in the [environmental variables section](Environmental-variables). @@ -38,6 +40,8 @@ Populate it with mandatory environmental variables, as described in the [environ #### 3. Build the local Docker images + + In SciNote root folder, run the following command: ``` @@ -68,6 +72,8 @@ Press `Ctrl + C` to shutdown the server. #### 4. Initialize the database + + To enter the SciNote container, run the following command when inside the SciNote root folder: ``` @@ -87,6 +93,8 @@ This sequence of commands will drop the database, create it, migrate the data sc #### 5. Load the front-end dependencies + + While still inside the container, run the following 2 commands: ``` @@ -121,6 +129,8 @@ That's it! Open your favourite browser and navigate to [`http://localhost:3000`] ## Docker containers + + SciNote server in development mode uses the following Docker containers: 1. `scinote_development_postgres` **(persistent)** hosts all database engine files, and is placed by default into `/var/lib/docker/volumes` folder on the host system; diff --git a/Contact-&-questions.md b/Contact-&-questions.md index 28b4f70..7b68f4a 100644 --- a/Contact-&-questions.md +++ b/Contact-&-questions.md @@ -1 +1,3 @@ + + Check out our [Support](https://scinote.net/support/) page for FAQ, as well as different ways of getting in touch with us. \ No newline at end of file diff --git a/Contributing-&-collaboration.md b/Contributing-&-collaboration.md index f3ddc49..4e14257 100644 --- a/Contributing-&-collaboration.md +++ b/Contributing-&-collaboration.md @@ -1,3 +1,5 @@ + + We'd love to hear your feedback. *SciNote* was developed with the aim to be a collaborative open-source project, so please open new issues describing any bugs, feature requests or suggestions that you have. > **DISCLAIMER: We firmly believe that our vision for the future of SciNote is the right one, therefore we reserve the right to accept OR reject any reported bugs and opened pull requests.** @@ -40,6 +42,8 @@ In order to accept your pull request, we need you to submit a CLA. You only need ## Code style + + We keep SciNote's codebase consistent by using various code styling conventions. We want to keep this practice in the future, therefore all contributions should follow the below code styling rules provided by various linter configuration files: * `Ruby` - [RuboCop](http://batsov.com/rubocop/) - [.rubocop.yml](https://github.com/biosistemika/scinote-web/blob/master/.rubocop.yml). diff --git a/Environmental-variables.md b/Environmental-variables.md index ff3e797..e39867d 100644 --- a/Environmental-variables.md +++ b/Environmental-variables.md @@ -2,6 +2,8 @@ SciNote reads configuration parameters from system environment parameters. On pr Below is an example `application.yml` file, which should get the server running; for full reference, check the dedicated section below to see all available variables. + + ```yml # Secrets SECRET_KEY_BASE: "<>" @@ -85,7 +87,7 @@ The following section describes all available environmental variables for SciNot | ENABLE_EMAIL_CONFIRMATIONS | No | Whether to require users to confirm the following actions: signing-up, signing-up after being invited, and changing their e-mail. Defaults to `true` on `development` and `production` environments, and to `false` on `test` environment. | | **Initial admin user** | | | | ADMIN_NAME | No | If using seeding (`rails db:seed`), the initial admin user's username. Defaults to `'Admin'`. | -| ADMIN_EMAIL | No | If using seeding (`rails db:seed`), the initial admin user's email. Defaults to `'admin@scinote.net'`. | +| ADMIN_EMAIL | No | If using seeding (`rails db:seed`), the initial admin user's email. Defaults to `'admin@scinote.net'`. | | ADMIN_PASSWORD | No | If using seeding (`rails db:seed`), the initial admin user's password. Defaults to `'inHisHouseAtRlyehDeadCthulhuWaitsDreaming'`. | | **reCaptcha** | | | | ENABLE_RECAPTCHA | No | Whether to enable [Google reCaptcha](https://www.google.com/recaptcha/) on sign-up and confirm invitation pages. Defaults to `false`. | diff --git a/Heroku.md b/Heroku.md index f57cace..06b08be 100644 --- a/Heroku.md +++ b/Heroku.md @@ -1,5 +1,7 @@ ## How to deploy SciNote onto Heroku + + Before deploying to Heroku, install heroku client as describe on offical website. To use existing heroku application, add new git remote repository. ``` diff --git a/Make-commands.md b/Make-commands.md index ad52b76..1dc4447 100644 --- a/Make-commands.md +++ b/Make-commands.md @@ -1,7 +1,7 @@ -TODO - ## `make` commands + + Call `make` commands to build Docker images and build Rails environment, including database. Following commands are available: @@ -13,7 +13,7 @@ Following commands are available: | `make run` | Runs the `db` container & starts the Rails server in `web` container. | | `make start` | Runs the `db` container & starts the Rails server in `web` container in background. | | `make stop` | Stops the `db` & `web` containers. | -| `make worker` | Runs the `rails jobs:work` (worker process) in `web` container. | +| `make worker` | Runs the `rails jobs:work` (worker process) in `web` container. | | `make cli` | Runs a `/bin/bash` inside the `web` container. | | `make tests` | Execute all Rails tests. | | `make console` | Enters the Rails console in `web` container. | diff --git a/Production-mode.md b/Production-mode.md index 3bf659b..ba2b7b1 100644 --- a/Production-mode.md +++ b/Production-mode.md @@ -1,5 +1,7 @@ ### Table of Contents + + * [Introduction](#user-content-introduction) * [Prerequisites](#user-content-prerequisites) * [Running server in production mode](#user-content-running-server-in-production-mode) @@ -83,7 +85,7 @@ Production SciNote server is using the following containers to operate: * `scinote_jobs_production` hosts the background worker process; * `scinote_web_production` hosts the web application process. -All persistent volumes will be kept safe in case you delete your Docker containers. +All persistent volumes will be kept safe in case you delete your Docker containers. > **WARNING!** Running `docker rm` with `-v` flag, however, will also delete these volumes (same thing happens if you run `docker-compose down` with `-v` flag). diff --git a/Rake-tasks.md b/Rake-tasks.md index b35238f..f64684f 100644 --- a/Rake-tasks.md +++ b/Rake-tasks.md @@ -1,5 +1,7 @@ ### Delayed jobs + + SciNote uses [delayed jobs](https://github.com/tobi/delayed_job) library to do background processing, mostly for the following tasks: * Sending emails, * Extracting text from uploaded files (*full-text* search), diff --git a/Setup-guide.md b/Setup-guide.md index a74c4a0..e8ddc70 100644 --- a/Setup-guide.md +++ b/Setup-guide.md @@ -20,10 +20,14 @@ SciNote server uses `rake`/`rails` tasks for various operations. For details reg ## Mailer + + SciNote needs a configured SMTP mail server to work properly. See [environmental variables](Environmental-variables) for configuration of the mailer. ## Office Online integration + + SciNote can be integrated with an Office Online Server to enable viewing and edition of documents directly in the browser. To enable this integration using the Microsoft Office Online servers, you will need to join the [Office Cloud Storage Partner Program](https://dev.office.com/programs/officecloudstorage) and set up the `WOPI_*` environment variables. ## Heroku diff --git a/Testing.md b/Testing.md index a9bc0aa..9331743 100644 --- a/Testing.md +++ b/Testing.md @@ -1 +1,3 @@ -*TODO* \ No newline at end of file +*TODO* + + \ No newline at end of file