Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/miladsoft/chart


https://github.com/miladsoft/chart

Last synced: 6 days ago
JSON representation

Awesome Lists containing this project

README

        

# πŸ“Š Technical Chart for Cryptocurrencies

Welcome to the **Technical Chart** project! This repository provides a real-time cryptocurrency technical chart using the TradingView widget, allowing users to select different time zones and toggle between light and dark themes. The demo showcases a simple yet powerful interface that displays live charts for various cryptocurrencies like Bitcoin and Ethereum.

## πŸš€ Demo
Check out the live demo [here](https://miladsoft.github.io/chart/).

## πŸ›  Features

- πŸ”„ **Real-time Charts**: The project leverages the TradingView widget for real-time charting of selected cryptocurrencies.
- 🌐 **Time Zone Selection**: Users can switch between multiple time zones, including London, Tehran, Muscat, Oslo, and Istanbul.
- πŸŒ— **Theme Toggle**: Easily switch between dark and light modes for a personalized viewing experience.
- πŸͺ™ **Cryptocurrency Selection**: Choose between major cryptocurrencies like Bitcoin and Ethereum with a simple click.

## πŸ“‚ Project Structure

```bash
chart/
β”œβ”€β”€ assets/
β”‚ β”œβ”€β”€ css/
β”‚ β”‚ └── style.css # Styling for the page
β”‚ β”œβ”€β”€ img/
β”‚ β”‚ β”œβ”€β”€ bitcoin.png # Bitcoin icon
β”‚ β”‚ └── ethereum.png # Ethereum icon
β”‚ └── js/
β”‚ └── script.js # JavaScript logic for theme, time zones, and TradingView integration
β”œβ”€β”€ index.html # Main HTML file
└── README.md # This README file
```

## πŸ’» Installation & Setup

1. **Clone the repository**:

```bash
git clone https://github.com/miladsoft/chart.git
cd chart
```

2. **Open `index.html` in your browser**:
You can open the file directly in your browser or use a local server to preview the project.

3. **View the Demo**:
For a live demo, visit [this link](https://miladsoft.github.io/chart/).

## πŸ“ How to Use

1. **Select a cryptocurrency**:
In the left panel, click on either Bitcoin or Ethereum to display the corresponding real-time chart.

2. **Change the time zone**:
Use the dropdown in the top menu to select a preferred time zone. The chart will update accordingly.

3. **Toggle the theme**:
Click the 'Dark' button in the top menu to switch between dark and light themes.

## 🀝 How to Contribute

We welcome contributions from the community! Here’s how you can get involved:

### Fork & Clone

1. Fork the repository by clicking on the 'Fork' button at the top of the page.
2. Clone your fork locally:

```bash
git clone https://github.com/your-username/chart.git
```

3. Create a new branch for your feature or bug fix:

```bash
git checkout -b feature/new-feature
```

### Making Changes

- Please follow the existing structure of the project.
- Ensure that your code is clean and well-documented.
- Before submitting, test your changes to ensure they work as expected.

### Pull Request

1. Once you’ve made your changes, push them to your fork:

```bash
git push origin feature/new-feature
```

2. Open a pull request from your branch on GitHub.

3. In the pull request description, explain what changes you’ve made and why.

4. We’ll review your request and merge it if everything looks good! πŸš€

## πŸ›  Future Improvements

We have several ideas to enhance this project, and you can help make it better:

- **Add more cryptocurrencies**: Support for additional coins beyond Bitcoin and Ethereum.
- **Enhance the UI**: Improve the charting interface, add animations, and refine responsiveness.
- **User Preferences**: Store theme and timezone preferences in local storage.
- **WebSocket Integration**: Implement real-time price updates via WebSocket for a more dynamic experience.

## πŸ“ž Support

If you have any issues or questions, feel free to open an issue on GitHub or reach out via the repository's issue tracker. We're happy to help!

## πŸŽ‰ Acknowledgments

- Thanks to **TradingView** for providing their excellent charting library.
- Icons from the **Cryptocurrency Icons** project.

---

Made with ❀️ by [Miladsoft](https://github.com/miladsoft)