-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #354 from Lemoncode/feature/readme.md
first update Readme
- Loading branch information
Showing
1 changed file
with
65 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,28 @@ | ||
# Quick mock 🎨 | ||
# Quick mock | ||
|
||
**Work in progres... 🚧 ** | ||
![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) | ||
|
||
The goal of this project is to create an open source low fidelity UI mock tool | ||
## 🌟 Project | ||
|
||
![quickmock](https://github.com/user-attachments/assets/a26e7302-0847-4377-80f0-39098791b371) | ||
Quick Mock is a free, open source online tool for quickly creating low fidelity UI mockups. | ||
|
||
# 🚀 Installation | ||
You can take a look at the desktop community preview at [Quick Mock](https://www.quickmock.net/) | ||
|
||
Clone this repository and run the following commands: | ||
[![Quick mock video tutorial](https://img.youtube.com/vi/NqswxUvXm4c/0.jpg)](https://www.youtube.com/watch?v=NqswxUvXm4c) | ||
|
||
Install dependencies | ||
## 🚀 Installation | ||
|
||
To install the project, clone the repository and run the following commands: | ||
|
||
```sh | ||
git clone https://github.com/Lemoncode/quickmock.git | ||
``` | ||
|
||
Install the dependencies | ||
|
||
```bash | ||
npm install | ||
|
@@ -24,9 +36,54 @@ 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: [email protected] | ||
|
||
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: [email protected]. | ||
|
||
## 👥 Team | ||
|
||
Contributors to this project | ||
Team members participating in this project | ||
|
||
<p align="left"> | ||
<a href="https://github.com/LourdesRsdp"> | ||
|