Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/javitocor/your-snooker-coach

A webApp that allows the user to book trainings with world class snooker players. Built with Ruby on Rails, React and Redux.
https://github.com/javitocor/your-snooker-coach

bootstrap4 css3 final-project heroku-deployment html5 postgresql rails-api reactjs redux webapp webpacker

Last synced: 11 days ago
JSON representation

A webApp that allows the user to book trainings with world class snooker players. Built with Ruby on Rails, React and Redux.

Awesome Lists containing this project

README

        

# README

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
![Hireable](https://cdn.rawgit.com/hiendv/hireable/master/styles/default/yes.svg)

# Your Snooker Coach

> A webApp that allows the user to book trainings with world class snooker players. Built with Ruby on Rails, React and Redux.

You can find the description of the project [here](https://www.notion.so/Final-Capstone-Project-Book-an-Appointment-41ded2ee99ff4fe4becf91acb332ca26) ("Catalogue of Statistics")

Landing Page:
![screenshot](./app/assets/images/screenshot1.png)

Login Page:
![screenshot](./app/assets/images/screenshot2.png)

App Landing Page:
![screenshot](./app/assets/images/screenshot3.png)

Player Profile:
![screenshot](./app/assets/images/screenshot4.png)

User Profile:
![screenshot](./app/assets/images/screenshot6.png)

About us:
![screenshot](./app/assets/images/screenshot5.png)

Additional description about the project and its features.

## Built With

- HTML
- CSS
- JAVASCRIPT
- RUBY ON RAILS
- REACT
- REDUX
- NPM
- NODE
- HEROKU
- ESLINT
- STYLELINT
- GITHUB ACTIONS
- VSCODE

## Live Demo

[Heroku Live Demo Link](https://yoursnookercoach.herokuapp.com/) :point_left:

[Presentation Video Link](https://www.loom.com/share/2a5470b4d11e48639d3a5570552feeb3) :point_left:

## Getting Started
- Follow the live demo link and book trainings with World Class players.

### Usage
To have this app on your pc, you need to:
* [download](https://github.com/javitocor/your-snooker-coach/archive/development.zip) or clone this repo:
- Clone with SSH:
```
[email protected]:javitocor/your-snooker-coach.git
```
- Clone with HTTPS
```
https://github.com/javitocor/your-snooker-coach.git
```

* In the project directory, you can run:

- `$ bundle install` - installs all the dependencies required by the project
- `cd client` - to access the react client
- `npm install` - installs all react and redux dependencies

- `$ rails server` - runs the rails app in the development mode
- `$ ./bin/webpack-dev-server` - in another terminal window to run react
- 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.

- `$ npm run test` - in the /client folder
- 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.
- `$ bundle exec rspec` - in the root directory
- Launches the test runner in the interactive watch mode.

- `$ npm run build` - in the /client folder
- 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!

## Future Features
- Add more locations.
- Add more players.
- Add extra UI.
- Add statistics
- Add call to external API

## Author

👤 Javier Oriol Correas Sanchez Cuesta
- Github: [@javitocor](https://github.com/javitocor)
- Twitter: [@JavierCorreas4](https://twitter.com/JavierCorreas4)
- Linkedin: [Javier Oriol Correas Sanchez Cuesta](https://www.linkedin.com/in/javier-correas-sanchez-cuesta-15289482/)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](https://github.com/javitocor/your-snooker-coach/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments 🚀

- [Microverse](https://www.microverse.org/)
- [Rails documentation](https://guides.rubyonrails.org/)
- [React Documentation](https://reactjs.org/docs/getting-started.html)
- [Heroku Documentation](https://devcenter.heroku.com/)
- [Redux](https://redux.js.org/)
- [World Snooker](https://wst.tv/)
- [Snooker API](http://api.snooker.org/)

## 📝 License

This project is [MIT](lic.url) licensed.

[contributors-shield]: https://img.shields.io/github/contributors/javitocor/your-snooker-coach.svg?style=flat-square
[contributors-url]: https://github.com/javitocor/your-snooker-coach/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/javitocor/your-snooker-coach.svg?style=flat-square
[forks-url]: https://github.com/javitocor/your-snooker-coach/network/members
[stars-shield]: https://img.shields.io/github/stars/javitocor/your-snooker-coach.svg?style=flat-square
[stars-url]: https://github.com/javitocor/your-snooker-coach/stargazers
[issues-shield]: https://img.shields.io/github/issues/javitocor/your-snooker-coach.svg?style=flat-square
[issues-url]: https://github.com/javitocor/your-snooker-coach/issuesover: