biorxivgo

README

BioRxivGo

This was created during my time as a student at Code Chrysalis.

The Curated Preprint Server for Genomics & BioInformatics.

Technologies

Setup environment

1. PostgreSQL Database

You will need postgres installed. If you haven't installed it already, download and install the PostgresApp and verify its working by running the command psql in your terminal.

Create a database for this project by running:

echo "CREATE DATABASE biorxiv | psql

Database migration & Data importing

You will need migrate installed. If you haven't installed it already, execute brew install golang-migrate in your MacOS.

Then, create a database schema using the following command.

# Update the database
migrate -path ./db/migrations -database postgres://postgres:postgres@localhost:5432/biorxiv?sslmode=disable up

# Rollback the database
migrate -path ./db/migrations -database postgres://postgres:postgres@localhost:5432/biorxiv?sslmode=disable down

2. dep: Go dependency management tool

You will need dep installed. If you haven't installed it already, execute the following commands in your MacOS.

brew install dep
brew upgrade dep

3. Starting REST API server

cd server
make run

4. Starting Front-end server

cd client
yarn serve

The list of libraries used for Back-end server

• mmcdole/gofeed
• golang-migrate/migrate
• gin-gonic/gin
• gorm
• lib/pq
• testify
• dep

Docker Compose

Image

How to start each docker container

docker-compose up
./setup4docker.sh

How to build each docker container image

Example:

docker build . -t biorxivgoback:dev
docker run --rm -p 9000:9000 biorxivgoback:dev