Skip to content

DragonRoyal/Periodic-Table

Repository files navigation

The Periodic Table Website

Welcome to the Periodic Table website, an open-source project designed to help users learn and explore the elements of the periodic table. This website provides a user-friendly interface, detailed information about each element, and interactive features to enhance your learning experience.

Planned Features

  • Element Information: Browse detailed information about each element, including its atomic number, symbol, name, and chemical properties. - Done
  • Interactive Table: Explore the periodic table with a customizable, interactive table that allows you to view elements based on their classification, state, or electron configuration.
  • Search Function: Quickly find any element by name, symbol, or atomic number using the search function. - Done
  • Quiz: Test your knowledge of the periodic table with a fun and educational quiz that covers topics such as element properties, electron configurations, and more.
  • User Accounts: Create a personal account to save your quiz scores, track your progress, and unlock additional features.

Roadmap

Week 1 (starting from 5/13/2023)

  • Login page

    • Finish login page frontend
    • Finish registration page frontend
  • Database

    • Connect and set database connections
    • check for security vulnerabilities

Week 2

  • More Database

    • link html login page to rust backend (database)
    • Make passwords have minimum lengths
  • Bug Squash

    • add "Error handing" to check if you put a valid email / password
    • Check for bugs

Week 3

  • Frontpage
    • Make a frontpage will all 118 elemements each linking to a page about the element

Week 4

  • Make accounts "useful"

    • Make a user dashboard
    • Make it look nice
  • Other

    • Make a "you do not have access" error message
    • incorporate this to other pages

Week 5

  • Quizzes"

    • Make quizzes about the elements
    • Polish the quizzes
  • Json

    • Find/make a json file with facts about elements then make the quizzes use that

Week 6

  • Quiz to Account"

    • Add quizzes "stats" to the dashboard
  • Maybe

    • Make it possible for users to customize the dashboard with markdown?

Week 7

  • Adding embeds
    • Make a dashboard embedded
    • Make embeds for other elements/pages

Week 7+

  • Optimise
    • Optimise backend and database
    • Optimise html, css and javascript files along with images
  • Polish
    • Make all element pages look more polished
    • Make the rest of the pages look better

Getting Started

As of now this website is a work in progress and very early in its development and has not been ported yet. Feel free to contribute

Contributing

We welcome contributions from the community to help improve and enhance the Periodic Table website. If you are interested in contributing to this open-source project, please visit our GitHub repository for more information.

License

The Periodic Table website is licensed under the MIT license, which allows for free use, modification, and distribution of the source code.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published