Commit f6bcd867 authored by uwwdp's avatar uwwdp
Browse files

Update readme

parent 36c1ccc6
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# kNN-Demo
## Available Scripts
A simple demo app for the k-nearest neighbor algorithm, written with React/Typescript.
In the project directory, you can run:
## Running the app
### `npm start`
Use `npm start` to run the app in development mode.
It can be viewed by visiting [http://localhost:3000/](http://localhost:3000/).
Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Building the app for production mode can be done by running `npm run build`.
The page will reload if you make edits.<br />
You will also see any lint errors in the console.
## Adding presets
### `npm test`
The preset configuration files can be found in the folder src/presets.
On executing `npm start` all presets are batched together into a single file called presets.json.
Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.<br />
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
To add a new preset, simply place in the folder mentioned beforehand, preferably under the name presetXX.json (XX being any double digit number).
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment