Neurogram is a high-technology ecosystem to serve neurophysiologists and researchers, expanding the neuroscience frontiers with features beyond the conventional.

Table of Contents

• Getting started
• Setup with ASDF
• Setup with Docker
• Deployment

Getting started

Officially supported version is 22.04.2 LTS. Although the project may work on other versions of Ubuntu or operating systems, we cannot guarantee an experience as optimized as in version 22.04.2 LTS.

Clone the project from github:

git clone git@github.com:ricardopacheco/auction_core_api.git api
cd api

Configure the environment variables according to your development and testing environment.

Setup with ASDF

Read the asdf documentation here. It contains the asdf setup process for your OS. As long as asdf has been installed and is working, navigate to the folder where you cloned the project and perform the following steps:

First all, environment variables should be properly configured:

cp lib/templates/.env.development.template .env
cp lib/templates/.env.test.template .env.test

OSX

• XCode
• Homebrew
• Brewfile

The setup on macOS may be incomplete. Pay attention to the requested dependencies, and update this section of the document if something is missing.

# Install XCode Command Line Tools if not installed
xcode-select --install

# Will detect the operating system and install dependencies and backing services
./devops/development/setup

Ubuntu

# Will detect the operating system and install dependencies and backing services
./devops/development/setup

Setup with Docker

You will need to have docker and docker compose installed to run the project correctly. Install according to your OS's official documentation:

• docker
• docker-compose

To verify that docker is working correctly, run the docker --version and docker compose --version commands. If the output of the command is the same like Docker version 20.10.23, build 7155243 and Docker Compose version v2.15.1 your installation should be ok. After that:

Environment variables should be properly configured:

cp lib/templates/.env.development.template .env
cp lib/templates/.env.test.template .env.test

Now, create a database and running services

docker compose run app bash
bundle exec rake 'auction_fun_core:db:create_database[postgres]'
bundle exec rake auction_fun_core:db:migrate
bundle exec rake 'auction_fun_core:db:seed_database
exit
docker compose up