.devcontainer | ||
assets | ||
electronic | ||
music | ||
robot | ||
sketch | ||
translator | ||
web | ||
.gitignore | ||
CONTRIBUTING.md | ||
deno.jsonc | ||
gowest.code-workspace | ||
import_map.json | ||
LICENSE-AGPL | ||
LICENSE-CERN | ||
README.md |
🪴 Gowest 🌱
The plant driven vehicle
Project overview
The Gowest project consist of a vehicle driven by plants used as light detector.
Gowest is split under the followings modules for flexibility, dev experience and to improve multiple profiles contributors involvement.
- ⚙️ Config (global project configuration)
- 🔌 Electronic (schemas and constrains)
- 🎶 Music (signal to music)
- 🤖 Robot (interface abstraction "voiture")
- 🪚 Sketch (models and draws for constructing)
- 🗣️ Translator (interface Vegetal Signal)
- 🌐 Web (remote control interface)
▶️ Usage
TBA
💭 Philosophy
This project is split under autonomous modules as a monorepo to:
- Provide an unique minimalist toolchain.
- Share dependencies, interfaces, assets, ... seamlessly.
- Unify and simplify base of knowledge.
- Distribute a coherent and complete releases.
We provide and work on Free/Libre and Open Source Softwares and try to use mostly well known standard (especially Web Standards) for security, resilience, portability and compatibility reasons.
For the same reasons and for readability and as common format we prefers plain text in most of the case.
To apply previous principles and use an ergonomic and minimalist toolchain most of the project use:
- json for datas and config files as it is a widely common config file syntax.
- markdown for text documents (documentations, wiki, ...) for his simplicity, flexibility and his widely usage.
- 🦕 deno as runtime and main toolchain utils for his use of web standard, all in one tool, single portable executable format.
- typescript for main code language for this support over all used platforms (embedded, server, web, ...) and the stability and security of a well typed interface.
📘 Documentation
- All public code is documented with JsDoc and accessible through doc/api.
- Hardware documentation and references is accessible through doc/sketch or doc/electronic.
- Usage, setup and additional information is disponible in the 📖 wiki.
🤝 Contributing
Any kind of contribution is welcomed. Please read contributing guidelines before and respect contributor covenant.