Skip to content

Latest commit

 

History

History
163 lines (124 loc) · 5.82 KB

README.md

File metadata and controls

163 lines (124 loc) · 5.82 KB
Raw

README

Contributors Forks Stargazers Issues Hireable

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 ("Catalogue of Statistics")

Landing Page: screenshot

Login Page: screenshot

App Landing Page: screenshot

Player Profile: screenshot

User Profile: screenshot

About us: screenshot

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 👈

Presentation Video Link 👈

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

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments 🚀

📝 License

This project is MIT licensed.