Skip to content

Kiel-H-Byrne/todaysMath

Repository files navigation

Vercel Github License Node Version W3C Validation

GitHub repo size Github code size Github Languages Github Top Language

todaysMath - The Supreme Calendar

This PWA is a utility to give you the Supreme Mathematics for the day; everyday.


Visit todaysmath.kielbyrne.com

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of node, and yarn.
  • You have a <Windows/Linux/Mac> machine. (I have not tested on Linux, but should work fine)
  • You have read SUPPORT.md.

Architecture

  • React.js
  • Material-UI
  • Next.js
  • Now Deployment

Documentation links can be found in SUPPORT

Contributing

First off, thank you for considering contributing to the Supreme Calendar. It’s people like you that make the Supreme Calendar such a great tool.

  1. Fork this repo
  2. Create a branch: git checkout -b <branch_name> (feature? bug?).
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin <project_name>/<location>
  5. Create the pull request. (Dont forget to test!)

Contributors

Thanks to the following people who have contributed to this project:

Licenses

Content is released under Mozilla Public License Version 2.0. See LICENSE.md for complete details, including attribution guidelines, contribution terms, and software and third-party licenses and permissions.

Roadmap as user stories

  • As an end-user, I would like to know today's math, so I can meditate on a concept for the day

Branches:

Try to name branches in a descriptive way, master, ft-<featureName>, fix-<fixName>, etc... No pull requests will be merged into master branch.

Resources:

Github Contribution setup

About

An online 365 day calendar giving you "Today's Mathematics" everyday, with room to discuss & build.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages