https://github.com/dunnock/bigneon

Meta-Project for building the Big Neon system locally
https://github.com/dunnock/bigneon

Last synced: 26 days ago
JSON representation

Meta-Project for building the Big Neon system locally

• Host: GitHub
• URL: https://github.com/dunnock/bigneon
• Owner: dunnock
• License: bsd-3-clause
• Created: 2020-03-06T09:45:13.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-06T11:50:05.000Z (about 5 years ago)
• Last Synced: 2025-03-27T08:59:53.652Z (about 1 month ago)
• Size: 22.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bigneon

Meta-Project for building the Big Neon system locally

# Installation

First clone this repo

       git clone https://github.com/big-neon/bigneon.git

       cd bigneon

# Usage

## Quick start

To pull images from docker hub and run the full development stack (recommended),

        make create-db

        make run

        

To build images locally from source code, rather than pull the prebuilt images from dockerhub, you can run      

(first time only):

    make init

    make sync

    make build 

    

The last command will take a long time. Go and grab some coffee. When done, copy the `env.example` file to `.env` and then you set up the DB

and launch the API with

    make create-db

    make run

    

From now on, you only need to run `make run` to get the API and front-end up and running; unless you need

a new version of the API, in which case, you start with `make sync`* and continue from there.

\* Take care that your repos are on the `master` branch first, perhaps by using `make status`

# Command Reference

## Clone all the repositories

Copy all the source code from github to your local machine. This will install all the projects in sibling

folders to the `bigneon` repo on your machine  

    make init

    

## List branches

Print the current branch for each repo to the console

    make status

## Synchronise your code

To periodically download all software updates and synchronise with github run

    make sync

    

**NB:** This script runs `git pull origin`, so if you want the latest `master` branch, make sure each repo

has the master branch checked out

## Build docker images

Rebuild all docker images locally

    make build

    

## Create or update the database table definitions

Pre-requisites:

* You need Postgres running (this guide assumes you're running a docker container):

        `docker-compose up db`

* Configure your `.env` file (or set environment variables specifically) with the database connection and

  `bn-db` repo location. See `.env.sample` for the list of envars that can be set.

Then to create the database for the first time, run

    make create-db

  

After this, to update the database with the latest migrations, run

    make migrate-db

## Run the API

To just run the backend (DB + API),

    make run-api

    

## Run the full stack

To download the latest images, run the DB, API and web front-end:

    make run