From 15e7bc61261063365c27f098a35c20f0bbbe5810 Mon Sep 17 00:00:00 2001 From: Braulio Date: Sat, 7 Sep 2024 21:13:36 +0200 Subject: [PATCH 01/10] first update --- README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 67 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c7d27f5d..e6d3e3af 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ -# Quick mock 🎨 +# Quick mock + +![Contributors](https://img.shields.io/github/contributors/Lemoncode/mongo-modeler) +![Forks](https://img.shields.io/github/forks/Lemoncode/mongo-modeler) +![Stars](https://img.shields.io/github/stars/Lemoncode/mongo-modeler) +![Licence](https://img.shields.io/github/license/Lemoncode/mongo-modeler) +![Issues](https://img.shields.io/github/issues/Lemoncode/mongo-modeler) + +## Project + +Quick Mock is a free, open source online tool for quickly creating low fidelity UI mockups. + +You can take a look at the desktop community preview at [Quick Mock](https://www.quickmock.net/) + +Click to watch the video tutorial: + +TODO: replace with the final video tutorial once uploaded to YouTube +[![Quick mock video tutorial](https://img.youtube.com/vi/87ZZbDZLido/0.jpg)](https://www.youtube.com/watch?v=87ZZbDZLido) + +## 🚀 Installation + +To install the project, clone the repository and run the following commands: + +```sh +git clone https://github.com/Lemoncode/quickmock.git +``` **Work in progres... 🚧 ** @@ -6,10 +31,6 @@ The goal of this project is to create an open source low fidelity UI mock tool ![quickmock](https://github.com/user-attachments/assets/a26e7302-0847-4377-80f0-39098791b371) -# 🚀 Installation - -Clone this repository and run the following commands: - Install dependencies ```bash @@ -24,9 +45,49 @@ npm run dev Open your browser and go to http://localhost:5173 (if this port is busy it will be changed to the next available port) +## Contributing + +Your feedback and contributions are welcome! If you have ideas for new features or have found a bug, we would love to hear about it. Here's how you can contribute: + +Report a Bug 🐛 + +If you encounter a bug in the project, please first check if it has already been reported in our GitHub Issues. If you don't find it there, feel free to open a new issue. Provide as many details as possible, including steps to reproduce the bug, the environment in which it occurs (operating system, project version, etc.), and any other relevant details. + +Propose a New Feature ✨ + +Do you have an idea to improve the project? Great! Share your thoughts with us by opening a new GitHub Issue under the feature request label. Describe the feature you would like to see, how and why you think it would be a valuable addition to the project. + +## Technologies + +The application is being developed using the following technologies: + +- [React](https://react.dev/) +- [React Konva](https://konvajs.org/) +- [TypeScript](https://www.typescriptlang.org/) +- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) / [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) / [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) +- [Vite](https://vitejs.dev/) +- [Vitest](https://vitest.dev/) + +## Sponsor Quick Mock + +Are you or your company interested in supporting Quick Mock? Sponsorship is a powerful way to contribute to the development and maintenance of our project, and we're always looking for partners who share our vision. + +Why Sponsor Quick Mock? + +- **Support Open Source:** Your sponsorship directly contributes to the open-source community, enabling us to maintain and improve our project. + +- **Visibility for Your Brand:** Sponsoring Quick Mock can provide visibility for your brand in the tech community. It's an excellent way to demonstrate your commitment to supporting innovative software development. + +- **Direct Impact:** Your support makes a tangible difference, allowing us to focus more on development, add new features, and improve the user experience. + +If you're interested in sponsoring this project, please feel free to reach out to us at: info@lemoncode.net + +Thank you for supporting open-source development! + + ## 👥 Team -Contributors to this project +Team members participating in this project

From e99dfdea22d7d71db51302729ab40fb84a403dc4 Mon Sep 17 00:00:00 2001 From: Braulio Date: Sat, 7 Sep 2024 21:16:31 +0200 Subject: [PATCH 02/10] updated badges --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e6d3e3af..03fea58e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Quick mock -![Contributors](https://img.shields.io/github/contributors/Lemoncode/mongo-modeler) -![Forks](https://img.shields.io/github/forks/Lemoncode/mongo-modeler) -![Stars](https://img.shields.io/github/stars/Lemoncode/mongo-modeler) -![Licence](https://img.shields.io/github/license/Lemoncode/mongo-modeler) -![Issues](https://img.shields.io/github/issues/Lemoncode/mongo-modeler) +![Contributors](https://img.shields.io/github/contributors/Lemoncode/quickmock) +![Forks](https://img.shields.io/github/forks/Lemoncode/quickmock) +![Stars](https://img.shields.io/github/stars/Lemoncode/quickmock) +![Licence](https://img.shields.io/github/license/Lemoncode/quickmock) +![Issues](https://img.shields.io/github/issues/Lemoncode/quickmock) ## Project From b793e9bcbab004e57a925841875f671f79191f18 Mon Sep 17 00:00:00 2001 From: Braulio Date: Sat, 7 Sep 2024 21:18:17 +0200 Subject: [PATCH 03/10] updated license --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..84b4929b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Lemoncode + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file From 03719c24a33036cfdf6eaa081146adb55a122199 Mon Sep 17 00:00:00 2001 From: Braulio Diez Date: Sat, 7 Sep 2024 21:19:03 +0200 Subject: [PATCH 04/10] Update LICENSE --- LICENSE | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index 84b4929b..580346f6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Lemoncode +Copyright (c) 2024 Lemoncode Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. From f71f8b579cad5a6ea4d9267cd967abafbf7a0669 Mon Sep 17 00:00:00 2001 From: Braulio Date: Sat, 7 Sep 2024 21:20:09 +0200 Subject: [PATCH 05/10] updated --- README.md | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 03fea58e..19bc312d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Project -Quick Mock is a free, open source online tool for quickly creating low fidelity UI mockups. +Quick Mock is a free, open source online tool for quickly creating low fidelity UI mockups. You can take a look at the desktop community preview at [Quick Mock](https://www.quickmock.net/) @@ -25,13 +25,7 @@ To install the project, clone the repository and run the following commands: git clone https://github.com/Lemoncode/quickmock.git ``` -**Work in progres... 🚧 ** - -The goal of this project is to create an open source low fidelity UI mock tool - -![quickmock](https://github.com/user-attachments/assets/a26e7302-0847-4377-80f0-39098791b371) - -Install dependencies +Install the dependencies ```bash npm install @@ -84,7 +78,6 @@ If you're interested in sponsoring this project, please feel free to reach out t Thank you for supporting open-source development! - ## 👥 Team Team members participating in this project From 59300e060b3d282db0551c4c65f3d870485f5bda Mon Sep 17 00:00:00 2001 From: Braulio Date: Sat, 7 Sep 2024 21:20:49 +0200 Subject: [PATCH 06/10] adding bold --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 19bc312d..21509746 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,11 @@ Open your browser and go to http://localhost:5173 (if this port is busy it will Your feedback and contributions are welcome! If you have ideas for new features or have found a bug, we would love to hear about it. Here's how you can contribute: -Report a Bug 🐛 +**Report a Bug 🐛** If you encounter a bug in the project, please first check if it has already been reported in our GitHub Issues. If you don't find it there, feel free to open a new issue. Provide as many details as possible, including steps to reproduce the bug, the environment in which it occurs (operating system, project version, etc.), and any other relevant details. -Propose a New Feature ✨ +**Propose a New Feature ✨** Do you have an idea to improve the project? Great! Share your thoughts with us by opening a new GitHub Issue under the feature request label. Describe the feature you would like to see, how and why you think it would be a valuable addition to the project. From 1d6899a60ea05fd16b7e2ea562289d6978dd2954 Mon Sep 17 00:00:00 2001 From: Braulio Date: Sat, 7 Sep 2024 21:28:27 +0200 Subject: [PATCH 07/10] tailor made --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 21509746..cad53fde 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,12 @@ If you're interested in sponsoring this project, please feel free to reach out t Thank you for supporting open-source development! +## 📐 Custom Component Libraries for Enterprise + +If your organization has its own design system and component library, we can create a custom set of low-fidelity mock components tailored to your palette and guidelines. This allows your team to create wireframes that align perfectly with your branding and design standards. + +For more information and to request a quote, feel free to contact us at: info@lemoncode.net. + ## 👥 Team Team members participating in this project From 94b146ed79b98636b107450f81c21f19d61d94e9 Mon Sep 17 00:00:00 2001 From: Braulio Date: Sat, 7 Sep 2024 21:36:00 +0200 Subject: [PATCH 08/10] adding emoticons --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cad53fde..051089d3 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ![Licence](https://img.shields.io/github/license/Lemoncode/quickmock) ![Issues](https://img.shields.io/github/issues/Lemoncode/quickmock) -## Project +## 🌟 Project Quick Mock is a free, open source online tool for quickly creating low fidelity UI mockups. @@ -39,7 +39,7 @@ npm run dev Open your browser and go to http://localhost:5173 (if this port is busy it will be changed to the next available port) -## Contributing +## 🤝 Contributing Your feedback and contributions are welcome! If you have ideas for new features or have found a bug, we would love to hear about it. Here's how you can contribute: @@ -51,7 +51,7 @@ If you encounter a bug in the project, please first check if it has already been Do you have an idea to improve the project? Great! Share your thoughts with us by opening a new GitHub Issue under the feature request label. Describe the feature you would like to see, how and why you think it would be a valuable addition to the project. -## Technologies +## 🛠️ Technologies The application is being developed using the following technologies: @@ -62,7 +62,7 @@ The application is being developed using the following technologies: - [Vite](https://vitejs.dev/) - [Vitest](https://vitest.dev/) -## Sponsor Quick Mock +## 💖 Sponsor Quick Mock Are you or your company interested in supporting Quick Mock? Sponsorship is a powerful way to contribute to the development and maintenance of our project, and we're always looking for partners who share our vision. From 3a39195b0f6a8cecfde9e1c64cb82390d4bad3c5 Mon Sep 17 00:00:00 2001 From: Braulio Date: Wed, 11 Sep 2024 08:07:19 +0200 Subject: [PATCH 09/10] update video --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 051089d3..133388a6 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ You can take a look at the desktop community preview at [Quick Mock](https://www Click to watch the video tutorial: TODO: replace with the final video tutorial once uploaded to YouTube -[![Quick mock video tutorial](https://img.youtube.com/vi/87ZZbDZLido/0.jpg)](https://www.youtube.com/watch?v=87ZZbDZLido) +[![Quick mock video tutorial](https://img.youtube.com/vi/NqswxUvXm4c/0.jpg)](https://www.youtube.com/watch?v=NqswxUvXm4c) ## 🚀 Installation From e61a96805f932fc79331e3ad43344f68b3a60dd7 Mon Sep 17 00:00:00 2001 From: Braulio Date: Wed, 11 Sep 2024 08:08:43 +0200 Subject: [PATCH 10/10] removed todo --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 133388a6..606d08ca 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,6 @@ Quick Mock is a free, open source online tool for quickly creating low fidelity You can take a look at the desktop community preview at [Quick Mock](https://www.quickmock.net/) -Click to watch the video tutorial: - -TODO: replace with the final video tutorial once uploaded to YouTube [![Quick mock video tutorial](https://img.youtube.com/vi/NqswxUvXm4c/0.jpg)](https://www.youtube.com/watch?v=NqswxUvXm4c) ## 🚀 Installation