01-getting-started

Tutorial 01 - Getting started

The goal of this tutorial is to scaffold, install and run your first Invenio instance. This step is identical to Quickstart

Step 1: Prerequisites

Follow the Prerequisites guide to prepare your local environment.

Step 2: Checkout source code

Open a terminal and checkout the tutorial's source code:

cd ~/src
git clone https://github.com/inveniosoftware/training.git

Tip: To copy/paste into the terminal inside the Ubuntu virtual machine use: Ctrl+Shift+V (paste), Ctrl+Shift+C (copy), Ctrl+Shift+X (cut).

Step 3: Scaffold

Scaffold the skeleton for your first Invenio instance:

cookiecutter gh:inveniosoftware/cookiecutter-invenio-instance -c v3.4 --no-input

Step 4: Install

Navigate to the scaffolded code, and start the Docker services (database, Elasticsearch, RabbitMQ and Redis cache):

cd my-site
docker-compose up -d

Install and build the Python and NPM dependencies:

./scripts/bootstrap

Step 5: Run

Setup the database tables, search indexes, queues and caches:

./scripts/setup

Start a development server and background job worker:

./scripts/server

Last, open https://127.0.0.1:5000/ in your browser:

firefox https://127.0.0.1:5000/

Browsers will display a security warning because we try to open a secure connection to a server with a self-signed certificate:

Simply bypass this warning, by clicking "Advanced" and confirm the certificate as an exception. Afterwards, you should see your first Invenio instance running: