Skip to content

Commit

Permalink
added README and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
jmccasusi committed Aug 26, 2019
1 parent 7825920 commit 4071ba8
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 58 deletions.
91 changes: 33 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,43 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# RUMBLE

## Available Scripts
A very fun app

In the project directory, you can run:
[Link to live client](https://www.google.com/)

### `npm start`
![screenshot of app](screenshot-01.png 'Screenshot 1')
![screenshot of app](screenshot-02.png 'Screenshot 2')
![screenshot of app](screenshot-03.png 'Screenshot 3')

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Features (Anonymous User)
- Allows to view all 'baby fighters' and their details such as win-loss records.
- Grants the ability to vote between two randomly selected babies, after which a vote will count as a win, and a loss for the other one
- Able to register for an account, allowing for access to more features

The page will reload if you make edits.<br>
You will also see any lint errors in the console.
## Features (Registered User)
- All features above
- Ability to login using created account
- Allows to create new baby fighters
- Able to edit or delete a 'baby fighter' if they are the creator

### `npm test`
## Features (Admin User)
- All features above
- Ability to edit or delete any 'baby fighter'

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.
## Technologies
- Node.js
- React
- MongoDB
- CSS / Bootstrap

### `npm run build`
## API/ Backend Server
- [https://bfc-backend-api.herokuapp.com/](https://bfc-backend-api.herokuapp.com/)
- [Github Link](https://github.com/jmccasusi/bfc_api/)

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.
## Future Improvements
-

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

### Code Splitting

This section has moved here: 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

### Making a Progressive Web App

This section has moved here: 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

### Deployment

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

### `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
## Team Members/Contributors
- Ruby King
- Bohdan Mykytey
- Joem Casusi
- Zach Gordon
Binary file added screenshot-01.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 screenshot-02.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 screenshot-03.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 4071ba8

Please sign in to comment.