Skip to content

Niall-J-Murray/Slipstream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

Slipstream F1 Draft Picks

Fantasy Formula 1 draft picks web app.
Full stack java web app, using Thymeleaf, Spring-Boot, Spring Security, Hibernate/JPA and MySQL.
View Deployment

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Slipstream F1
This is project is designed to showcase my knowledge of the stacks and frameworks listed below. It will also be used as a base for further development of those stacks, as well as learning and integrating new ones.

As a fan of Formula 1 and fantasy sports, I noticed a lack of a draft pick format fantasy F1 game, so I created one! The draft pick format means that users teams are all different, instead of the majority of users being able to pick the same players/drivers. This game is also designed to appeal more to novice fans, and introduces an element of luck to users’ chances of winning.

The app will continue to evolve, feedback, suggestions and bug reports are welcome.

(back to top)

Built With

(back to top)

Getting Started

You can visit Slipstream-F1 to try the app online.

Instructions on how to play are on the homepage.

You must register an account and login to see the full application.

Alternatively, you can clone or fork the app and download it to run locally.

Prerequisites

To run locally, you will need an IDE with Java 17 or higher.

You will also need a MySQL localhost on port 3306, and will need to edit the application.properties file to access your localhost: i.e.: "spring.datasource.username=" and "spring.datasource.password=" will need correct credentials for your localhost.

The app will automatically create a database at "spring.datasource.url=jdbc:mysql://localhost:3306/slipstream", unless you create one named "slipstream" manually.

Installation

  1. Clone the repo
    git clone https://github.com/Niall-J-Murray/Slipstream.git
  2. Import the repo to your IDE
  3. Build and run the application
  4. Open your web browser and go to:
 http://127.0.0.1:8080/
  1. This will lead you to the homepage, with instructions on how to play the game.
  2. Register an account then login to play.

(back to top)

Usage

This app is designed as a fun and easy introduction to Formula 1 and fantasy sports. It can give players someone to root for if they have no previous experience of F1. Given the relatively minimal amount of time required to play, it can also be of interest to more serious fans, who may also play more traditional fantasy sports game already.

Currently, some of the functionality is fairly limited (e.g., players can't choose or create a league to join). This functionality will be added as the project is developed.

This project could also be forked and adapted to use for different sports with relatively little changes needed.

(back to top)

Roadmap

  • Add optional automated email to allow users to receive email prompts when it is their turn to pick.
  • Improve UI, especially for smaller screens.
  • Allow users to choose which league to join.
  • Allow users to create their own leagues.
    • Users can customise leagues by changing number of teams, picks etc...
  • Create advanced leagues with additional ways of scoring points, based on predictions etc.

See the issues to request features and see known issues.

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/NewFeature)
  3. Commit your Changes (git commit -m 'Add some NewFeature')
  4. Push to the Branch (git push origin feature/NewFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License. See LICENSE for more information.

(back to top)

Contact

Niall Murray - @linkedin - niall_murray@outlook.com

Project Link: https://github.com/Niall-J-Murray/Slipstream

(back to top)

Acknowledgments

  • Coders Campus Java Boot Camp
  • ergast.com

(back to top)

About

Fantasy Formula 1 draft web app using Java, Spring boot, Spring Security and MySQL, with Thymeleaf front-end

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors