aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: fa24ecf9d8ad8a93ea3fc06e04b13e1104d259fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# Model Viewer Demo

A demo of how to use react and three.js to view and manipulate models.

## Running and Building

This project uses a `Makefile` for all tasks.

- `make dev` runs the local development server.
- `make build` creates builds the js bundle.

## Linting and Formatting

This project uses `prettier` and `eslint`.

- `make format` formats the code (and runs lints) 
- `make lint` lints the  code

## Running Tests

- `make test` Runs the tests

## Container

This project includes a Containerfile that you can use to quickly run the
project.

## License

Licensed under AGPL 3.0