Skip to content

A browser-based game where the player guesses a daily-rotating target year based on given historical events. Made with React in TypeScript.

Notifications You must be signed in to change notification settings

syedi-code/historicle

Repository files navigation

Historicle

A browser-based game where the player guesses a daily-rotating target year based on given historical events. Historicle is hosted online at historiclega.me. Inspired by other browser "dailies" such as Wordle, PokeDoku, and Cine2Nerdle among others.


alt text

Run Locally

Historicle can be run locally by cloning the repository and using npm to start a local development server:

git clone https://github.com/syedi-code/historicle.git
cd historicle
npm install
npm run start

Technologies

Project Structure

  • src/components contains all React components
    • GameContainer is the parent component and is where the bulk of the game logic takes place
  • src/data contains the historical event parser
    • api-request.py interfaces with the Historical Events API, cleaning and formatting the data before exporting it to data.json
    • data.json contains the cleaned data, which is imported in the GameContainer component
    • api-request.py is run automatically every day at midnight PST by GitHub Actions

About

A browser-based game where the player guesses a daily-rotating target year based on given historical events. Made with React in TypeScript.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published