The plants driven vehicle. The Gowest project consist of a vehicle driven by plants used as light detector.
Go to file
2024-03-07 14:35:00 +01:00
.devcontainer style: 🎨 initial format applied 2024-01-10 17:23:46 +01:00
assets docs: 📝 add logo and update global readme 2024-03-07 14:35:00 +01:00
electronic docs: 📝 add and update readme of all modules 2024-03-07 14:03:20 +01:00
music docs: 📝 add and update readme of all modules 2024-03-07 14:03:20 +01:00
robot docs: 📝 add and update readme of all modules 2024-03-07 14:03:20 +01:00
sketch docs: 📝 add and update readme of all modules 2024-03-07 14:03:20 +01:00
translator docs: 📝 add and update readme of all modules 2024-03-07 14:03:20 +01:00
web docs: 📝 add and update readme of all modules 2024-03-07 14:03:20 +01:00
.gitignore initial commit 2024-01-10 13:17:19 +01:00
CONTRIBUTING.md docs: 📝 update contributing guidelines 2024-03-07 12:43:46 +01:00
deno.jsonc feat(config): 📦 add electronic module 2024-03-07 13:49:03 +01:00
gowest.code-workspace feat(config): 📦 add electronic module 2024-03-07 13:49:03 +01:00
import_map.json feat(config): 📦 add electronic module 2024-03-07 13:49:03 +01:00
LICENSE-AGPL docs: 📄 add software and hardware licenses 2024-03-07 12:17:54 +01:00
LICENSE-CERN docs: 📄 add software and hardware licenses 2024-03-07 12:17:54 +01:00
README.md docs: 📝 add logo and update global readme 2024-03-07 14:35:00 +01:00

logo

🪴 Gowest 🌱

The plant driven vehicle

project doc License: AGPL License: AGPL

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.