Skip to content

jsomeara/HackPNW2024

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

SATShark is an innovative multiplayer educational game designed to enhance SAT preparation while engaging in competitive gameplay.
By: John O'Meara, Aditya Bankoti, Berkan Mertan, Ian Kim
Explore the repo »

View Video · 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

SATShark was made at HackPNW 2024 Spring Hackathon. When we first heard the prompt, "Make the Boring Not Boring," we unanimously jumped to the most procrastinated, most mind-numbing, and most boring thing we all had to go through right now and this week: SAT prep. We loved online competitive platforms for coding, like Clash of Code or CF or the now-deleted binarysearch.com, and we wondered: how do they turn the mundane task of practicing into something so exciting and still extremely educational? We realized that the ultimate solution to SAT prep was SATShark, an easy-to-use, community multiplayer website where users can make private lobbies, load up a queue of questions, and race to finish all the questions correctly before their friends do. It takes inspiration from CodinGame, LeetCode, the College Board, and multiplayer games like Valorant and Apex to create a competition that maximizes attention and incentivizes users to become the best SAT takers they can be and turn SAT testing into an immensely fun experience.

(back to top)

Built With

  • Vue
  • EXPRESS
  • Tailwind
  • MongoDB

(back to top)

Getting Started

Install Node.JS, and in each frontend and backend folder, run npm i to install each library. After, run npm run dev from each respective end-point to run the dev server.

Insatll MongoDB and import the sample DBs from the ./backend/server/mongo/

Make sure to update the DB URL in ./backend/server/index.js and change the back-end API link in the ./frontend/src/client.js

(back to top)

Usage

The front end URL should be https://localhost:5173 and the backend https://localhost:3000

(back to top)

Roadmap

  • AP Exam database
  • Online Features
    • Chat Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. We would greatly appreciate any contributions you make.

If you have a suggestion to improve this, please fork the repo and create a pull request. You can also open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

TBD

(back to top)

Acknowledgments

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •