71 wiersze
1.8 KiB
Markdown
71 wiersze
1.8 KiB
Markdown
This is an attempt by [Nina Paley][] (art) and [Atul Varma][] (code) to tinker
|
|
with procedural art.
|
|
|
|
Right now there is no particular goal other than to explore various ideas.
|
|
The project consists of a web site with multiple pages, each of which is
|
|
an experiment of some kind.
|
|
|
|
It can be [viewed online][] or iterated on locally using the instructions below.
|
|
|
|
## Quick start
|
|
|
|
This requires [NodeJS][]. It was started with
|
|
NodeJS 14.15.4, but hopefully it should work with
|
|
any recent version.
|
|
|
|
After cloning the repository and entering it, run:
|
|
|
|
```
|
|
npm run watch
|
|
```
|
|
|
|
then visit http://localhost:1234.
|
|
|
|
## Running tests
|
|
|
|
To run tests interactively, run:
|
|
|
|
```
|
|
npm run test:watch
|
|
```
|
|
|
|
## Type checking
|
|
|
|
To make sure that everything type-checks okay, run:
|
|
|
|
```
|
|
npm run typecheck
|
|
```
|
|
|
|
Note that you may want to install a [TypeScript plugin for your favorite editor][ts-editor]. Aside from telling you what type errors you have in real-time, editor integration also provides code autocompletion and other affordances that can greatly improve your productivity. For more details, see Atul's [Fun with TypeScript][] series of videos.
|
|
|
|
[ts-editor]: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support
|
|
[Fun with TypeScript]: https://www.youtube.com/playlist?list=PL79r88piDzwZVwCI_26T3ZjC3xKvQLgjh
|
|
|
|
## Code style
|
|
|
|
All code styling is managed by [Prettier][].
|
|
|
|
To format the code automatically, run:
|
|
|
|
```
|
|
npm run prettier:fix
|
|
```
|
|
|
|
You can alternatively install a Prettier extension for your editor; see its website for more details.
|
|
|
|
[Prettier]: https://prettier.io/
|
|
|
|
## Deployment
|
|
|
|
To deploy the project to GitHub Pages, run:
|
|
|
|
```
|
|
npm run deploy
|
|
```
|
|
|
|
[NodeJS]: https://nodejs.org/en/
|
|
[Nina Paley]: https://blog.ninapaley.com/
|
|
[Atul Varma]: https://portfolio.toolness.org/
|
|
[viewed online]: https://mysticsymbolic.art/
|