Skip to content

Commit

Permalink
Updated readme and added screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
villanovachile committed Feb 28, 2023
1 parent 234e236 commit 9580d17
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 51 deletions.
71 changes: 20 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,39 @@
# Getting Started with Create React App
# Truth Tally

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts
Link to web app: [https://truthtally.danielr.io/](https://truthtally.danielr.io/)

In the project directory, you can run:
## Description

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `npm 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.

### `npm run 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!
This React based app will allow you to create a list, and sort based on your choice from randomized unique pairings.

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

### `npm run eject`
1. Enter a list of items to compare (i.e., Beatles, Led Zeppelin, Pink Floyd, Black Sabbath)
2. Click/tap on Begin
3. Select a favored item from one of the pairs of items displayed.
4. Results are then displayed.

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
`- The Begin button only appears once there are 3 items in the list`

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.
`- Each selection increases the score of the selected item`
`- Rate Again will clear scores and begin the ratng process again`

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.
`- Start Over will clear the list, requiring entering items again`

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
## Screenshots

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
![Screenshot](./screenshots/screenshot01.png)

To learn React, check out the [React documentation](https://reactjs.org/).
![Screenshot](./screenshots/screenshot02.png)

### Code Splitting
![Screenshot](./screenshots/screenshot03.png)

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)
### `npm start`

### Deployment
To develop further on this app, you will want to fork the repo, then clone your fork into your local git repository.

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
In terminal, CD into your cloned repo and enter `npm install`, then run the app by entering `npm start`

### `npm run 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)
Binary file added screenshots/screenshot01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/screenshot02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/screenshot03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9580d17

Please sign in to comment.