Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(readme) 🐛 fix typos and formatting #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+45 −50
Open

fix(readme) 🐛 fix typos and formatting #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 45 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@

<div align="center">

![logo](public/logo/android-chrome-192x192.png)

<h1 align="center" >Astralyn</h1>

![cntr](https://img.shields.io/github/contributors/issam-seghir/astralyn?color=pink&style=for-the-badge)
![pullreQ](https://img.shields.io/github/issues-pr/issam-seghir/astralyn?color=orange&style=for-the-badge)
![comt](https://img.shields.io/github/last-commit/issam-seghir/astralyn?style=for-the-badge)
[![GPL3 License](https://img.shields.io/badge/License-GPL3-green.svg?style=for-the-badge)](https://choosealicense.com/licenses/gpl-3.0/)

![frk](https://img.shields.io/github/forks/issam-seghir/astralyn?style=flat-square)
![str](https://img.shields.io/github/stars/issam-seghir/astralyn?style=flat-square)
![deploy](https://img.shields.io/website?down_color=red&down_message=down&style=flat-square&up_color=succes&up_message=up&url=https%3A%2F%2Fissam-seghir.github.io%2Fastralyn%2F)

<img src="public/logo/android-chrome-192x192.png" alt="logo">
<h1 align="center">Astralyn</h1>

<img src="https://img.shields.io/github/contributors/issam-seghir/astralyn?color=pink&style=for-the-badge" alt="contributors">
<img src="https://img.shields.io/github/issues-pr/issam-seghir/astralyn?color=orange&style=for-the-badge" alt="pull requests">
<img src="https://img.shields.io/github/last-commit/issam-seghir/astralyn?style=for-the-badge" alt="last commit">
<a href="https://choosealicense.com/licenses/gpl-3.0/" target="_blank"><img src="https://img.shields.io/badge/License-GPL3-green.svg?style=for-the-badge" alt="GPL3 License"></a>

<img src="https://img.shields.io/github/forks/issam-seghir/astralyn?style=flat-square" alt="forks">
<img src="https://img.shields.io/github/stars/issam-seghir/astralyn?style=flat-square" alt="stars">
<img src="https://img.shields.io/website?down_color=red&down_message=down&style=flat-square&up_color=success&up_message=up&url=https%3A%2F%2Fissam-seghir.github.io%2Fastralyn%2F" alt="website status">

<p align="center">

"**Astralyn | Your Comprehensive Dashboard Experience**"

**Astralyn** isn't just a **dashboard**, it's a universe of possibilities within reach—an immersive, feature-rich platform, From managing your **e-commerce business** with **data grid** tables and visualization-rich **charts** to accessing full-fledged **applications** like **kanban** **boards**, **schedulers** for appointments, and an **interactive** **map**, **Astralyn** offers a comprehensive toolkit.
<strong>"Astralyn | Your Comprehensive Dashboard Experience"</strong>
<br />
<br />
<strong>Astralyn</strong> isn't just a <strong>dashboard</strong>; it's a universe of possibilities within reach—an immersive, feature-rich platform. From managing your <strong>e-commerce business</strong> with <strong>data grid</strong> tables and visualization-rich <strong>charts</strong> to accessing full-fledged <strong>applications</strong> like <strong>kanban boards</strong>, <strong>schedulers</strong> for appointments, and an <strong>interactive map</strong>, <strong>Astralyn</strong> offers a comprehensive toolkit.
<br />
<br />
<a href="https://issam-seghir.github.io/astralyn/">View Demo</a>
Expand All @@ -28,13 +25,11 @@
<a href="https://github.com/issam-seghir/astralyn/pulls">Request Feature</a>
</p>

<br>
<hr>
<hr>

<a title="Check Lighthouse out" target="_blank" href="https://github.com/GoogleChrome/lighthouse"><img alt="Lighthouse Average Results" width="275" src="https://img.shields.io/badge/Lighthouse-Average_Results-2A2E30.svg?logo=lighthouse&cacheSeconds=3600" /></a><br>
<a title="Check Lighthouse out" target="_blank" href="https://github.com/GoogleChrome/lighthouse"><img alt="Lighthouse Average Results" width="275" src="https://img.shields.io/badge/Lighthouse-Average_Results-2A2E30.svg?logo=lighthouse&cacheSeconds=3600" /></a><br>

<img width="700" src="lighthouse_results/desktop/pagespeed.svg" />
<br>
<img width="700" src="lighthouse_results/desktop/pagespeed.svg" alt="Lighthouse Results">
</div>

<br>
Expand All @@ -43,16 +38,16 @@

### Built With

- ![HTML5](https://img.shields.io/badge/html5-%231572B6.svg?style=for-the-badge&logo=html5&logoColor=white)
- ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
- ![SASS](https://img.shields.io/badge/sass-%237e2a3d.svg?style=for-the-badge&logo=sass&logoColor=ff577b)
- ![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
- ![JOY](https://img.shields.io/badge/JOYUI-%230081CB.svg?style=for-the-badge&logo=mui&logoColor=white)
- ![Syncfusion](https://custom-icon-badges.demolab.com/badge/syncfusion-113451?style=for-the-badge&logo=syncfusion&&logoColor=113451&)
- ![million](https://custom-icon-badges.demolab.com/badge/million-%23AF73D8.svg?style=for-the-badge&logo=million&logoColor=white)
- ![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
- ![Leaflet](https://custom-icon-badges.demolab.com/badge/leaflet-41B883?style=for-the-badge&logo=leaflet&&logoColor=256b4c&)
- ![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
- <img src="https://img.shields.io/badge/html5-%231572B6.svg?style=for-the-badge&logo=html5&logoColor=white" alt="HTML5">
- <img src="https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E" alt="JavaScript">
- <img src="https://img.shields.io/badge/sass-%237e2a3d.svg?style=for-the-badge&logo=sass&logoColor=ff577b" alt="SASS">
- <img src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" alt="React">
- <img src="https://img.shields.io/badge/JOYUI-%230081CB.svg?style=for-the-badge&logo=mui&logoColor=white" alt="JOY">
- <img src="https://custom-icon-badges.demolab.com/badge/syncfusion-113451?style=for-the-badge&logo=syncfusion&&logoColor=113451&" alt="Syncfusion">
- <img src="https://custom-icon-badges.demolab.com/badge/million-%23AF73D8.svg?style=for-the-badge&logo=million&logoColor=white" alt="million">
- <img src="https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white" alt="React Router">
- <img src="https://custom-icon-badges.demolab.com/badge/leaflet-41B883?style=for-the-badge&logo=leaflet&&logoColor=256b4c&" alt="Leaflet">
- <img src="https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white" alt="Vite">

## Features

Expand All @@ -65,18 +60,18 @@
- Diagram Drawer
- Expense Tracker
- Map Visualization
- 🔥 3 Dynamic Data Grids: Includes Pagination, Edit/Add/Delete Capabilities, Filtering, Searching and more.
- 🔥 3 Dynamic Data Grids: Includes Pagination, Edit/Add/Delete Capabilities, Filtering, Searching, and more.
- 🧪 Interactive Data Visualization
- ⚡ Exporting Capabilities: Seamlessly Export Charts, Notes, and Table Data to Formats such as PDF, Excel, and CSV.
- 💻 responsive for all mobile devices
- 💼 Every thing cashed on Local storage
- 💻 Responsive for all mobile devices
- 💼 Everything cached on Local storage

### User Customization Options

- 🌓 Dark/lgiht mode (default system)
- 🌓 Dark/light mode (default system)
- 🎨 3 different themes
- 🌍 multiple languge ( only english & arabic for this moment , default preferred language)
- ✨ Additional Effects : like rainbow blur bg (new - experimental)
- 🌍 Multiple languages (only English & Arabic for this moment, default preferred language)
- ✨ Additional Effects: like rainbow blur bg (new - experimental)

<!-- GETTING STARTED -->
## Getting Started
Expand All @@ -96,14 +91,16 @@ This is an example of how to list things you need to use the software and how to

### Installation

1. Claim your free Community License [here](https://www.syncfusion.com/sales/communitylicense)
1. Claim your free Community License [here](https://www.syncfusion.com/sales/communitylicense).

> see [syncfusion-documentation-licensing](https://ej2.syncfusion.com/react/documentation/licensing/license-key-generation) for more information about how to register the api
> See [syncfusion-documentation-licensing](https://ej2.syncfusion.com/react/documentation/licensing/license-key-generation) for more information about how to register the API.

2. Clone the repo

```sh
git clone https://github.com/github_username/repo_name.git


```

3. Install NPM packages
Expand All @@ -116,17 +113,16 @@ This is an example of how to list things you need to use the software and how to

```js
import { registerLicense } from "@syncfusion/ej2-base";
//...
// Registering Syncfusion license key
registerLicense(import.meta.env.VITE_SYNCFUSION_LICENSE_KEY);
//...
// Registering Syncfusion license key
registerLicense(import.meta.env.VITE_SYNCFUSION_LICENSE_KEY);
```

> see [.env.example](.env.example) file .
> See [.env.example](.env.example) file.

<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
Expand All @@ -137,12 +133,11 @@ Don't forget to give the project a star! Thanks again!
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<!-- LICENSE -->
## License

Distributed under the GPL3 License. See `LICENSE.txt` for more information.

## Support Me

<a href="https://www.buymeacoffee.com/issam.seghir" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy ma A Coffee" style="width: 174px !important;height: 41px !important;box-shadow: 0 3px 2px 0 rgb(190 190 190 / 50%) !important;" ></a>
<a href="https://www.buymeacoffee.com/issam.seghir" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy me A Coffee" style="width: 174px !important;height: 41px !important;box-shadow: 0 3px 2px 0 rgb(190 190 190 / 50%) !important;" ></a>
</div>