edea

README

EDeA Backend

This contains the program edead which handles the API, serving the portal web assets and caching of modules.

Running it

Grab the latest tagged release

from here (to be done), unpack it, adjust the database connection information in config.yml and run it like this:

./edead

This should output helpful log information to the standard output in case something goes wrong.

Or if you have a working Go installation, you can just run

go get gitlab.com/edea-dev/edead/cmd/edead
go install gitlab.com/edea-dev/edead/cmd/edead
$GOPATH:/bin/edead

Development

1. Install Dependencies

We use tilt for live updating and docker compose for the database and search images.

1. Clone the repository

git clone https://gitlab.com/edea-dev/edead && cd edead

1. Run a local dev environment with tilt

tilt up

That's it.

Running tests

To run the frontend tests:

cd frontend
npx playwright test

Administration

We'll add any routine administrative tasks to the documentation as they arise after the portal goes live on edea.dev.

Dependencies

edead needs a variety of tools to be available on the host to function:

• python >=3.8
  • merge tool, plotpcb
• svgcleaner
  • svg preparation for caching
• KiCAD 5.x
  • plotpcb
• plotgitsch
  • Plotting differences in the schematic
• mdbook
  • rendering of the documentation

Documentation

Index

• Variables

Variables

var BootstrapIcons embed.FS

BootstrapIcons holds the bootstrap-icons svg files to render them directly into the templates. it only increases the binary size by ~1MB.