https://github.com/brianhicks/elm-guardian

pre-build server for Elm packages
https://github.com/brianhicks/elm-guardian

Last synced: 6 days ago
JSON representation

pre-build server for Elm packages

• Host: GitHub
• URL: https://github.com/brianhicks/elm-guardian
• Owner: BrianHicks
• Created: 2018-02-16T22:58:08.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-17T05:00:00.000Z (almost 7 years ago)
• Last Synced: 2024-12-09T19:53:31.842Z (14 days ago)
• Language: Elixir
• Size: 93.8 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Guardian

This is gonna be a pre-publish server for Elm packages when it grows up.

Stuff like:

- classic validations like

  - is the `elm-package.json` good?

  - is the version bump correct?

  - does it not contain privileged code (native/kernel), or code meant for apps only (ports)?

- run the tests makes sure they pass

  - eventually: run the tests for downstream packages, make sure those pass when upgraded (if non-major version.)

- remove non-essential assets for code downloads (images, test code, etc)

## Developin'

This is an Elixir/Phoenix project, with an Elm frontend (because of course.)

The backend does a bunch of validations and exposes it to the frontend via GraphQL.

This is not all set up yet, and if you need instructions please ping Brian so he updates this doc.

But basically for the backend:

- [install Elixir](https://elixir-lang.org/install.html) (hint: `brew install elixir`)

- `mix deps.get`

- `mix phoenix.server`

## TODO

- [ ] simple UI for viewing builds

- [ ] tests for database stuff (also probably add some sort of fixture handling)

- [ ] initial validations (those that package.elm-lang.org does)

- [x] store packages, versions, and build requests

- [x] provide build requests to the frontend (graphql / absinthe)