Giter VIP home page Giter VIP logo

nerves-metal-detector / nerves_metal_detector Goto Github PK

View Code? Open in Web Editor NEW
13.0 1.0 3.0 558 KB

Find hardware supported by the Nerves Framework and where to buy it

Home Page: https://nerves-metal-detector.org

License: MIT License

Elixir 88.42% CSS 0.09% JavaScript 5.47% HTML 5.08% Dockerfile 0.80% Shell 0.10% Batchfile 0.04%
displays elixir hardware i2c iot nerves-project sbc sbcomputers sensors spi

nerves_metal_detector's Introduction

NervesMetalDetector

Test Status

The Nerves Metal Detector is an application with the goal to show all Nerves Framework supported hardware, where to buy it and its availability.

Roadmap

  • Product availability update functionality
  • Coverage of rpilocator.com catalogue (in progress)
  • Non-RPi SBC Products
  • Proper design

How to contribute

Contributions that add new vendors, products and product update items (vendor-item relation) are greatly welcome.

See the CONTRIBUTING document for detailed information. Especially the section about adding the items from rpilocator.com.

Local Development

The project is a standard Phoenix Framework application.

Database

The docker-compose.yml in the root folder defines a simple Postgres Docker container.

Run docker-compose up to start the database.

Any other way of running a Postgres database works as well.

Running the server

To start the Phoenix server:

  • Make the environment variables in .envrc.dist available. When using direnv, copy the file to .envrc and run direnv allow .
  • Run mix setup to install and setup dependencies
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

Fetching/Updating Product Availabilities

Product availabilities are updated every hour via an Oban cronjob.

The updates can be manually scheduled by running the server in an iex session and scheduling the NervesMetalDetector.Jobs.ScheduleProductUpdates job.

$ iex -S mix phx.server
iex(1)> NervesMetalDetector.Jobs.ScheduleProductUpdates.new(%{}) |> Oban.insert()

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.