Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ppconde committed Feb 2, 2023
1 parent 3972a16 commit 5a6097d
Showing 1 changed file with 1 addition and 43 deletions.
44 changes: 1 addition & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ In order to run this project follow the following steps:
- Install [Node 16](https://nodejs.org/en/blog/release/v16.16.0/) - you can also use [Node Version Manager](https://github.com/nvm-sh/nvm)
- Open the command line in the project's root and run `yarn` - it will install all the dependencies of the project
- Still in the command line in the project's root, run `yarn start` - it will run the app in development mode;
- Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
- All the commits pushed to `master` branch will be deployed directly to production. Check [Github Action](https://github.com/esnaveiro/voting-booth/actions) to see the status of the deployment
- Happy coding! :)

Expand All @@ -14,46 +15,3 @@ This app was developed with:
- [Firebase](https://firebase.google.com/), [Firebase Realtime Database](https://firebase.google.com/docs/database/web/start) and [FirebaseUI](https://github.com/firebase/firebaseui-web)
- [Antd](https://ant.design/)
- [Typescript](https://www.typescriptlang.org/)

## Available Scripts

In the project directory, you can run:

### `yarn start`

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

The page will reload if you make edits.\
You will also see any lint errors in the console.

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

0 comments on commit 5a6097d

Please sign in to comment.