Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
catherinekago authored Aug 27, 2021
1 parent c08e0ef commit 959b8be
Showing 1 changed file with 11 additions and 63 deletions.
74 changes: 11 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,18 @@
# Getting Started with Create React App
# SurvEye
## A Gaze-Based Questionnaire for Individuals with Manual Difficulties

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
SurvEye is a project that aims to provide accessible digital questionnaires for people with manual difficulties. The goal within the scope of my Bachelor's Thesis is to investigate different questionnaire designs to retrieve design recommendations for gaze-based questionnaires and provide developers with reusable components to faciliate the creation of gaze-based questionnaires. In the future, it would be desirable to incorporate this work into a questionnaire tool for researchers, where they can easily assemble their questionnaire and generate both mouse-based and gaze-based versions of the questionnaire to distribute among their study participants.

## Available Scripts
This project was created with the use of [Webgazer](https://github.com/brownhci/WebGazer), a JavaScript library for eye tracking.

In the project directory, you can run:
SurvEye consists of:
1. A mouse-free calibration sequence to calibrate the eye tracking technology
2. An optional validation sequence where accuracy is being measured
3. A Questionnaire consisting of different layouts and interaction element designs

### `yarn start`
A demonstration of the current state of SurvEye can be found [here](https://relaxed-sinoussi-3ccc09.netlify.app).

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
If you want to learn more about how the different features of SurvEye work, check out the Wiki 🕵️‍♀️.

The page will reload if you make edits.\
You will also see any lint errors in the console.
### Getting it up and running

### `yarn test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn build`

Builds the app for production to the `build` folder.\
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.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn 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/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `yarn build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

0 comments on commit 959b8be

Please sign in to comment.