Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doersino/tixyz
A minimalist three-dimensional coding environment. Control 8x8x8 dots with a single JavaScript function.
https://github.com/doersino/tixyz
Last synced: 16 days ago
JSON representation
A minimalist three-dimensional coding environment. Control 8x8x8 dots with a single JavaScript function.
- Host: GitHub
- URL: https://github.com/doersino/tixyz
- Owner: doersino
- Created: 2020-11-06T12:54:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-15T19:42:19.000Z (over 3 years ago)
- Last Synced: 2024-08-01T00:46:43.367Z (3 months ago)
- Language: JavaScript
- Homepage: https://doersino.github.io/tixyz/
- Size: 2.38 MB
- Stars: 157
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tixyz
*A minimalist three-dimensional coding environment. Control 8x8x8 dots with a single JavaScript function.*
#### 🔴 Give it a whirl at https://doersino.github.io/tixyz/ or check out [some examples](https://twitter.com/doersino/status/1325494757779513344)!
Let me be abundantly clear: This thing is *wholly* derivative, merely adding a third dimension to Martin Kleppe's creative code golfing tool [tixy](https://twitter.com/aemkei/status/1323399877611708416) by mashing it up with David DeSandro's [Zdog](https://zzz.dog). Those two deserve any and all credit.
![](demo.gif)
## Development
### Setup
Fairly typical for a modern JavaScript thing. If you're just starting out with that toolchain, first install a reasonably recent release of [Node.js](https://nodejs.org/en/) – it's almost certainly available through your package manager. Then:
```bash
$ git clone https://github.com/doersino/tixyz
$ cd tixyz
$ npm install
```If you don't regularly work with Node.js, make sure `./node_modules/.bin/` is on your path:
```bash
export PATH="./node_modules/.bin:$PATH"
```### Workin' it
Open `src/index.js` (or whatever file you want to work on) in your preferred text editor. Then execute:
```
$ npm run start
```This will automatically build the project, fire up a basic web server, and ask your browser to navigate to it. Whenever you save any changes now, the project will be rebuilt and – like magic – your browser will refresh the page.
### Build & Deploy
If you want to generate a static version, run the following command:
```bash
$ npm run build
```To deploy it on GitHub Pages, execute:
```sh
$ npm run deploy
```This will first revert the `dist/` directory to a clean slate, then do `npm run build`, and finally use the `gh-pages` package to commit the now-current `dist/` directory to the `gh-pages` branch of this repository (it will create it if it doesn't already exist).
## License
[According to tixy's `package.json`](https://github.com/aemkei/tixy/issues/20#issuecomment-723643187), it's licensed under the [ISC License](https://www.isc.org/licenses/). *I don't think the changes I've made to it are sufficient for licensing tixyz any differently.*