evrimagaci / periodum

Periodum: An Interactive, Open-Source Periodic Table!

Periodum: An Interactive Periodic Table Project

This project started as a Turkish periodic table developed by Evrim Ağacı & Bionluk, and then evolved into an open-source community project and then finally, an international science project. We have a path forward and we are seeking programmers that are willing to take on the language expansion process. Contribute to the project if you're interested - and feel free to ask any questions if you cannot figure out anything (because of language or for any other reason)!

Important Links

• Periodum Periodic Table (Latest Version): https://periodum.com/

Key Docs

• Project Needs & Roadmap: https://github.com/evrimagaci/periodum/projects/1
• Design File: https://dar.vin/4Ksrj You can access the design file using Sketch or Adobe XD.

Related Repos

• Backend & API: https://github.com/evrimagaci/periodum-api
• iPad and macOS Client: https://github.com/evrimagaci/periodum-apple

Installation

Steps

1. Complete the mysql setup via this link.
2. Download the db.sql.zip database file.
3. Export the db.sql file in the downloaded folder to the project main directory.
4. Go to the main directory of the project via the terminal and enter sh setup.sh command.

Commands

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

Testing

We use @testing-library/vue library for testing. You can check the cheat sheet here and see example tests here.

Please follow the GitLab testing guide for the testing structure and format.

Contribution Guidelines

Please click here to learn more about how to contribute to Periodum project.