From e881c9e1e9eea40059dec6d5dd2467138ad03092 Mon Sep 17 00:00:00 2001 From: Haziq Khairi Date: Fri, 19 Jan 2024 18:53:53 +0800 Subject: [PATCH 1/2] docs: Update README.md --- README.md | 132 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 127 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f768e33..d8b4774 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,130 @@ -# React + Vite + -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] -Currently, two official plugins are available: + +
+
+ + Logo + -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +

ArtistryHub

+ +

+ + + + + View Demo + · + Report Bug + · + Request Feature +

+
+ + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Getting Started + +
    3. +
  3. Contributing
    4. +
+
+ + + +## About The Project + +ArtistryHub is a digital gallery where users can explore some of the world's most famous and renowned paintings. This platform is designed with simplicity and elegance, utilizing latest technologies to offer a smooth and accessible browsing experience. Perfect for art enthusiasts and casual viewers alike, ArtistryHub provides a window to the rich world of art history, presenting each masterpiece in a format that's easy to navigate and enjoy. Whether you're a seasoned art connoisseur or just curious about the world of paintings, ArtistryHub offers a professional and enriching visual journey. + +

(back to top)

+ +### Built With + +- [![Vite][Vite]][Vite-url] +- [![React][React.js]][React-url] +- [![TailwindCSS][TailwindCSS]][TailwindCSS-url] + +

(back to top)

+ + + +## Getting Started + +### Prerequisites + +Ensure you have pnpm installed on your system. If not, install it globally using: + +```sh +npm install -g pnpm +``` + +### Installation + +Follow these steps to set up the project locally: + +1. Clone the project repository: + ```sh + git clone https://github.com/Kyziq/artistry-hub.git + ``` +2. Install dependencies with `pnpm`: + ```sh + pnpm install + ``` + +

(back to top)

+ + + +## 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**. + +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! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)

+ + + + +[contributors-shield]: https://img.shields.io/github/contributors/Kyziq/artistry-hub.svg?style=for-the-badge +[contributors-url]: https://github.com/Kyziq/artistry-hub/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/Kyziq/artistry-hub.svg?style=for-the-badge +[forks-url]: https://github.com/Kyziq/artistry-hub/network/members +[stars-shield]: https://img.shields.io/github/stars/Kyziq/artistry-hub.svg?style=for-the-badge +[stars-url]: hhttps://github.com/Kyziq/artistry-hub/stargazers +[issues-shield]: https://img.shields.io/github/issues/Kyziq/artistry-hub.svg?style=for-the-badge +[issues-url]: https://github.com/Kyziq/artistry-hub/issues +[license-shield]: https://img.shields.io/github/license/Kyziq/artistry-hub.svg?style=for-the-badge +[license-url]: https://github.com/Kyziq/artistry-hub/blob/master/LICENSE.txt +[product-screenshot]: images/screenshot.png +[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB +[React-url]: https://reactjs.org/ +[TailwindCSS]: https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white +[TailwindCSS-url]: https://tailwindcss.com/ +[Vite]: https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white +[Vite-url]: https://vitejs.dev/ From 0c7850055ed102d6e2ca4322b2effff88be8db4c Mon Sep 17 00:00:00 2001 From: Haziq Khairi Date: Fri, 19 Jan 2024 18:58:58 +0800 Subject: [PATCH 2/2] docs: style badges to center --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index d8b4774..c5ab379 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ +
+ [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] +
+