storyschematics

README

---

---

This is a quickstart document to test the project locally.

You can find the API documentation on the repository GitHub page.

Want to contribute? Check the contribution guidelines.

Run locally

Pre-requisites

• Golang

• Node.js

• Python

  • Install pipx to install command-line tools.

• Podman

  • Install podman-compose

    # Pipx
    pipx install podman-compose
    
    # Brew
    brew install podman-compose
    

• Make

  # Debian / Ubuntu
  sudo apt-get install build-essential
  
  # macOS
  brew install make
  

  For Windows, you can use Make for Windows

Setup environment

Create a .envrc file from the template:

cp .envrc.template .envrc

Then fill the missing secret variables. Once your file is ready:

source .envrc

You may use tools such as direnv, otherwise you'll need to source the env file on each new terminal session.

Install the external dependencies:

make install

Et Voilà!

make api
# 3:09PM INF starting application... app=story-schematics
# 3:09PM INF application started! address=:4001 app=story-schematics