Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FabDonRixos authored Oct 25, 2024
1 parent a983049 commit 2a87bfd
Showing 1 changed file with 110 additions and 2 deletions.
112 changes: 110 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,110 @@
# css-arts
A Collection of CSS only Arts 🖼️
<p align="center">
<a href="https://awesome-arts.fabian.li/" target="_blank">
<img src="https://github.com/FabDonRixos/awesome-arts/blob/master/logo_with_text.svg" alt="logo" />
</a>
</p>

<h4 align="center">Create CSS Only components or just get inspired by them</h4>

<p align="center">
<a href="http://creativecommons.org/publicdomain/zero/1.0/" >
<img src="https://img.shields.io/github/license/FabDonRixos/awesome-arts" />
</a>

<a href="https://github.com/FabDonRixos/awesome-arts/tags" >
<img src="https://img.shields.io/github/v/tag/FabDonRixos/awesome-arts" />
</a>

<img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103" />

<a href="https://github.com/FabDonRixos/awesome-arts.git" >
<img src="https://img.shields.io/badge/Contributions-are_welcomed-green.svg" alt="Contributions are welcomed" />
</a>

<a href="https://awesome-arts.fabian.li/" >
<img src="https://img.shields.io/website?url=https%3A%2F%2Fawesome-arts.fabian.li" />
</a>
</p>

<p align="center">
<a href="https://awesome-arts.fabian.li" target="blank">Website</a>
·
<a href="https://github.com/FabDonRixos/awesome-arts/issues/new/choose">Report Bug</a>
·
<a href="https://github.com/FabDonRixos/awesome-arts/issues/new/choose">Request Feature</a>
·
<a href="https://github.com/FabDonRixos/awesome-arts/issues/new/choose">Suggest Components</a>
</p>

<!-- [![Stargazers over time](https://starchart.cc/FabDonRixos/awesome-arts.svg?variant=adaptive)](https://starchart.cc/FabDonRixos/awesome-arts) -->

# `🖐️` Introducion `Awesome-Arts`
`Awesome-Arts` is an open-source repository designed to showcase your amazing and inspiring CSS-only artworks. Join our community of creative developers and share your unique designs while exploring the endless possibilities of CSS art. Contribute your creations and inspire others!

> \[!IMPORTANT]
>
> **Star this Repository**, to stay updated on all new Additions \~
Check out my other projects:<br/>
[fabian.li »](https://fabian.li/home)<br/>
[TranZero »](https://github.com/FabDonRixos/TranZero)

#

# `🏗️` Set up `Awesome-Arts` locally
1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and clone this repository
```
git clone https://github.com/FabDonRixos/awesome-arts.git
```
2. Install all dependencies
```
npm install
```
3. Start the application
```
npm start
```
4. Now you can open [localhost:5173](http://localhost:5173/)

# `🚧` Build with
- [React vite](https://vite.dev/guide/): The best React-based framework in the universum.
- [TypeScript](https://www.typescriptlang.org/): A programming language that adds static typing to JavaScript.
- [Sass/Scss](https://sass-lang.com/guide/): A preprocessor, that interpreted or compiled into CSS,
- [vite-plugin-svgr](https://www.npmjs.com/package/vite-plugin-svgr): A Plugin to transforme SVGs to React Components.
- [Eslint](https://eslint.org/): Static code analysis tool to find problematic patterns inside JavaScript / TypeScript

# `📧` Get in contact
If you have any more questions about / suggestions for the project you can:
- Message me via [mail](mailto:contact@fabian.li).
- Create an [Issue](https://github.com/FabDonRixos/awesome-arts/issues/new/choose)
- Join out [Discord server](https://discord.com/) (not yet opened)

# `🛡️` License
This project was licensed under the CC0-1.0 License.
<br />
See [`License`](LICENSE) for details.

# `🤝` Contributing to `Awesome-Arts`
Contributions are very welcomed, and you can contribute in many diffrent ways:
- Contribute to the Project by creating your own Components.
- Contribute to the Project by giving others ideas for what to implement next.
- Contribute to the Project by Reporting Bugs.
- Contribute to the Project by giving us feedback so we can improve.
- **But most importantly, your presence and support are valuable contributions to the project.**

> Please read [`CONTRIBUTING`](CONTRIBUTING.md) for the process to submitting pull requests.
>
> Please read [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md) to lern about our standards.
# `💕` Support
💚 Thanks for your support to the Project. We are very pleased to have you here.

---

<h3 align="center">
A ⭐️ to <b>Awesome-Arts</b> to add yourself to the Milkyway 🌌.
</h3>

<h4 align="center">
And Stay Awesome
</h3>

0 comments on commit 2a87bfd

Please sign in to comment.