Different architectonical elements of the Pick By Light project are stored in different repositories. So to help you find what you need, here is a list of repos with their contents.
A description and diagrams about how the components work with each other can be found in the Process Diagrams file.
The backend repo contains code for a server with
-
authorization
-
database
-
controllers
-
http-Tests
-
docker
You can also start by reading the backend documentation.
The graphical user interface allows the user to interact with the system and sends requests to the backend and embedded system. A login system ensures that only authorized users can use the system. The desired parts are selected via a search mask and displayed via the further connection. Extended setting options are available to the administrator. Parts and shelfs can be created and managed.
From a technical point of view, the frontend is realized with vue and vuetify and is running in a nginx docker container. The different components are presented on individual pages.
View the documentation.
Everything you need to physically build the project and code for low-level servers.
Files for 3D-printing and explainations on how to upgrade your shelves using LEDs. Documentation
Code for a server that translates HTTP-Requests and sends corresponding MQTT messages to the ESP32s. Documentation
Firmware of the ESP32s, which receive the MQTT messages and control the LEDs. Documentation
If you are new to the project, we recommend reading the docs of the respective repository (as listed above).
You want to make a contribution to the project?
Here you can find a list of Issues you can work on. Also check the Issues in the Sub-Repositiories. New features and code changes are organized throug Pull Requests. If you're new to the concept, check out this description.
You have discovered a bug or have an idea for a new feature?
You can add a new Issue here.
When changes are made, check if other repositories are affected!
Example:
In the backend repo, the attribute name in User entity is changed to username.
Because this affects the frontend, one should check the frontend repo before commiting the changes.
Build instructions can be found in the README files of the repos.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License from here.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.