README.md 737 Bytes
Newer Older
Oliver Wirth's avatar
Oliver Wirth committed
1
# kNN-Demo
2

Oliver Wirth's avatar
Oliver Wirth committed
3
A simple demo app for the k-nearest neighbor algorithm, written with React/Typescript.
4

Oliver Wirth's avatar
Oliver Wirth committed
5
![screenshot](./public/screenshot.png "Screenshot")
Oliver Wirth's avatar
Oliver Wirth committed
6

Oliver Wirth's avatar
Oliver Wirth committed
7
## Running the app
8

Oliver Wirth's avatar
Oliver Wirth committed
9
10
Use `npm start` to run the app in development mode.
It can be viewed by visiting [http://localhost:3000/](http://localhost:3000/).
11

Oliver Wirth's avatar
Oliver Wirth committed
12
Building the app for production mode can be done by running `npm run build`.
13

Oliver Wirth's avatar
Oliver Wirth committed
14
## Adding presets
15

Oliver Wirth's avatar
Oliver Wirth committed
16
The preset configuration files can be found in the folder `./presets/`.
Oliver Wirth's avatar
Oliver Wirth committed
17
On executing `npm start` or `npm run build` all presets are batched together into a single file called presets.json.
18

Oliver Wirth's avatar
Oliver Wirth committed
19
To add a new preset, simply place in the folder mentioned beforehand, preferably under the name presetXX.json (XX being any double digit number).