An open API service indexing awesome lists of open source software.

https://github.com/rohancyberops/periodictable


https://github.com/rohancyberops/periodictable

Last synced: over 1 year ago
JSON representation

Awesome Lists containing this project

README

          

![Periodic Table](R.png)
---

# ๐ŸŒŸ Periodic Table

A sleek and interactive application that dynamically generates a Periodic Table of Elements using data from a CSV file. This project showcases all known chemical elements with their respective properties and allows users to explore details about each element easily.

## ๐Ÿš€ Features
- Interactive Periodic Table layout generated dynamically from CSV data.
- Displays detailed information about each element, including:
- Atomic number
- Symbol
- Name
- Atomic mass
- Electron configuration
- User-friendly design with a responsive UI for all devices.

## ๐Ÿ› ๏ธ Technologies Used
- **Python**: Pre-processes and serves the data from the CSV file.
- **CSV**: Stores data about the elements in a structured format.
- **JavaScript**: Dynamically generates the table and adds interactivity.

## ๐Ÿ“‚ Project Structure
```
PeriodicTable/
โ”œโ”€โ”€ src/
โ”‚ โ”œโ”€โ”€ app.py # Main Python script for serving the application
โ”‚ โ”œโ”€โ”€ data/
โ”‚ โ”‚ โ””โ”€โ”€ elements.csv # CSV file containing element data
โ”‚ โ”œโ”€โ”€ js/
โ”‚ โ”‚ โ””โ”€โ”€ script.js # JavaScript for interactivity
โ”‚ โ”œโ”€โ”€ templates/
โ”‚ โ”‚ โ””โ”€โ”€ index.html # HTML file for the UI
โ”‚ โ””โ”€โ”€ static/
โ”‚ โ””โ”€โ”€ css/
โ”‚ โ””โ”€โ”€ style.css # Stylesheet for design
โ”œโ”€โ”€ LICENSE # License file
โ””โ”€โ”€ README.md # Documentation
```

## ๐Ÿ’ป Getting Started

### Prerequisites
- Python 3.x installed on your system.
- A modern web browser (Chrome, Firefox, Edge, etc.).

### Installation
1. Clone the repository:
```bash
git clone https://github.com/chrohangurjar/PeriodicTable.git
```
2. Navigate to the project directory:
```bash
cd PeriodicTable
```
3. Install required Python packages:
```bash
pip install -r requirements.txt
```
4. Run the Python script:
```bash
python src/app.py
```
5. Open your browser and visit `http://127.0.0.1:5000` to explore the Periodic Table.

## ๐Ÿงช Demo
[Live Demo](#) โ€” *(Add the link to a live demo or deployment if available)*

## ๐Ÿค Contributing
Contributions are welcome! Feel free to:
- Fork the repository.
- Submit pull requests with improvements or fixes.

## ๐Ÿ“œ License
This project is licensed under the [MIT License](LICENSE).

## ๐Ÿ“ง Contact
**Rohan Naagar**
- GitHub: [@chrohangurjar](https://github.com/chrohangurjar)
- Email: [Rohan150907@gmail.com](mailto:Rohan150907@gmail.com)

---