Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hipsterbrown/xs-dev
The quickest way for getting started with JS on devices
https://github.com/hipsterbrown/xs-dev
esp32 esp8266 iot moddable pico
Last synced: 3 days ago
JSON representation
The quickest way for getting started with JS on devices
- Host: GitHub
- URL: https://github.com/hipsterbrown/xs-dev
- Owner: HipsterBrown
- License: mit
- Created: 2021-12-01T18:22:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T16:17:53.000Z (6 months ago)
- Last Synced: 2024-03-23T17:25:29.543Z (6 months ago)
- Topics: esp32, esp8266, iot, moddable, pico
- Language: TypeScript
- Homepage: https://xs-dev.js.org
- Size: 2.31 MB
- Stars: 34
- Watchers: 8
- Forks: 12
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CLI for automating the setup and usage of [Moddable XS tools](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/Moddable%20SDK%20-%20Getting%20Started.md)
The Moddable SDK and associated dev board tooling is incredibly empowering for embedded JS hardware development, however the set up process can be tedious to follow when getting started. This project aims to streamline the install and environment configuration requirements across platforms in just a few commands.
[Check out the documentation!](https://hipsterbrown.github.io/xs-dev/)
**This project is a work in progress and currently pre-1.0, so there may be breaking changes.**
## Requirements
[Node.js >= v16](https://nodejs.org/en/)
_If you've never installed Node.js before, check out the [getting started guide for xs-dev](https://hipsterbrown.github.io/xs-dev/guide/00-prepare#nodejs-package-manager-optional)._
[XZ utils](https://tukaani.org/xz/) are required to install the CLI due to a dependency for decompressing the ARM toolchain used for nrf52 development.
It can be installed with Homebrew on MacOS:
```
brew install xz
```
Or as `xz-utils` on Linux distributions like [Ubunutu](https://packages.ubuntu.com/search?keywords=xz-utils):
```
apt-get install xz-utils
```
**On Linux:**
Setup commands rely on [`ssh-askpass`](https://packages.ubuntu.com/focal/ssh-askpass) to prompt for permission when installing other tools and dependencies.
## Install
```
npm install -g xs-dev
```
```
pnpm install -g xs-dev
```
```
yarn global add xs-dev
```
## Update to latest release
```
npm update -g xs-dev
```
```
pnpm update -g xs-dev
```
```
yarn global upgrade xs-dev
```
## Features & Usage
Check out the [docs](https://hipsterbrown.github.io/xs-dev/) to learn about using xs-dev and getting started with embedded JS development.
## Development
Clone the project and install dependencies. We're using [pnpm](https://pnpm.io/) and [volta](https://volta.sh/) to manage packages and Node.
```
git clone https://github.com/HipsterBrown/xs-dev.git
cd xs-dev
pnpm install
```
Link dev version of CLI using `pnpm`, which will override any other globally installed version:
```
pnpm link --global
pnpm link --global xs-dev
```
Or create an alias to clearly denote the local version of the CLI:
```
alias local-xs-dev=$PWD/bin/xs-dev
```
To maintain the alias between shell sessions, for example I use zsh:
```
echo "alias local-xs-dev=$PWD/bin/xs-dev" >> ~/.zshrc
```
## Docs
The documentation site is built with [Astro](https://astro.build) with the [Starlight template](https://starlight.astro.build/) and can be found in the `docs/` directory. When working on them locally, run `pnpm start:docs` to start the development server that watches for file changes and reloads the page.
### 🚀 Docs Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the `public/` directory.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
