0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-01-06 14:50:20 -05:00
penpot/README.md

176 lines
9.2 KiB
Markdown
Raw Normal View History

2018-10-24 15:55:29 -05:00
2018-11-25 07:36:46 -05:00
[uri_license]: https://www.mozilla.org/en-US/MPL/2.0
[uri_license_image]: https://img.shields.io/badge/MPL-2.0-blue.svg
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://penpot.app/images/readme/github-dark-mode.png">
<source media="(prefers-color-scheme: light)" srcset="https://penpot.app/images/readme/github-light-mode.png">
<img alt="penpot header image" src="https://penpot.app/images/readme/github-light-mode.png">
</picture>
2024-10-28 04:05:35 -05:00
<p align="center">
<a href="https://www.mozilla.org/en-US/MPL/2.0" rel="nofollow"><img alt="License: MPL-2.0" src="https://img.shields.io/badge/MPL-2.0-blue.svg" style="max-width:100%;"></a>
<a href="https://community.penpot.app" rel="nofollow"><img alt="Penpot Community" src="https://img.shields.io/discourse/posts?server=https%3A%2F%2Fcommunity.penpot.app" style="max-width:100%;"></a>
2024-10-28 04:05:35 -05:00
<a href="https://tree.taiga.io/project/penpot/" title="Managed with Taiga.io" rel="nofollow"><img alt="Managed with Taiga.io" src="https://img.shields.io/badge/managed%20with-TAIGA.io-709f14.svg" style="max-width:100%;"></a>
<a href="https://gitpod.io/#https://github.com/penpot/penpot" rel="nofollow"><img alt="Gitpod ready-to-code" src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" style="max-width:100%;"></a>
</p>
2018-10-24 15:55:29 -05:00
<p align="center">
2024-04-08 10:28:10 -05:00
<a href="https://penpot.app/"><b>Website</b></a>
<a href="https://help.penpot.app/technical-guide/getting-started/"><b>Getting Started</b></a>
<a href="https://help.penpot.app/user-guide/"><b>User Guide</b></a>
<a href="https://help.penpot.app/user-guide/introduction/info/"><b>Tutorials & Info</b></a>
<a href="https://community.penpot.app/"><b>Community</b></a>
</p>
2024-04-08 10:28:10 -05:00
<p align="center">
<a href="https://www.youtube.com/@Penpot"><b>Youtube</b></a>
<a href="https://peertube.kaleidos.net/a/penpot_app/video-channels"><b>Peertube</b></a>
<a href="https://www.linkedin.com/company/penpot/"><b>Linkedin</b></a>
<a href="https://instagram.com/penpot.app"><b>Instagram</b></a>
<a href="https://fosstodon.org/@penpot/"><b>Mastodon</b></a>
<a href="https://twitter.com/penpotapp"><b>X</b></a>
</p>
2024-04-09 10:11:41 -05:00
2024-04-08 04:49:56 -05:00
<br />
[Penpot video](https://github.com/penpot/penpot/assets/5446186/b8ad0764-585e-4ddc-b098-9b4090d337cc)
<br />
2024-04-08 04:50:55 -05:00
2024-04-08 10:28:10 -05:00
Penpot is the first **open-source** design tool for design and code collaboration. Designers can create stunning designs, interactive prototypes, design systems at scale, while developers enjoy ready-to-use code and make their workflow easy and fast. And all of this with no handoff drama.
2016-11-20 14:08:24 -05:00
2024-04-08 04:49:56 -05:00
Penpot is available on browser and [self host](https://penpot.app/self-host). Its web-based and works with open standards (SVG, CSS and HTML). And last but not least, its free!
2020-10-28 06:11:25 -05:00
2024-04-08 10:28:10 -05:00
Penpots latest [huge release 2.0](https://penpot.app/dev-diaries), takes the platform to a whole new level. This update introduces the ground-breaking [CSS Grid Layout feature](https://penpot.app/penpot-2.0), a complete UI redesign, a new Components system, and much more. Plus, it's faster and more accessible.
2024-04-08 04:49:56 -05:00
🎇 **Penpot Fest** is our design, code & Open Source event. Check out the highlights from [Penpot Fest 2023 edition](https://www.youtube.com/watch?v=sOpLZaK5mDc)!
2017-03-01 04:54:37 -05:00
## Table of contents ##
2021-06-23 05:52:10 -05:00
- [Why Penpot](#why-penpot)
- [Getting Started](#getting-started)
- [Community](#community)
- [Contributing](#contributing)
- [Resources](#resources)
2021-06-23 05:52:10 -05:00
- [License](#license)
## Why Penpot ##
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
Penpot expresses designs as code. Designers can do their best work and see it will be beautifully implemented by developers in a two-way collaboration.
2024-10-28 05:30:35 -05:00
### Plugin system ###
[Penpot plugins](https://penpot.app/penpothub/plugins) let you expand the platform's capabilities, give you the flexibility to integrate it with other apps, and design custom solutions.
2024-04-08 04:49:56 -05:00
### Designed for developers ###
Penpot was built to serve both designers and developers and create a fluid design-code process. You have the choice to enjoy real-time collaboration or play "solo".
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
### Inspect mode ###
Work with ready-to-use code and make your workflow easy and fast. The inspect tab gives instant access to SVG, CSS and HTML code.
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
### Self host your own instance ###
Provide your team or organization with a completely owned collaborative design tool. Use Penpot's cloud service or deploy your own Penpot server.
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
### Integrations ###
Penpot offers integration into the development toolchain, thanks to its support for webhooks and an API accessible through access tokens.
### Whats great for design ###
With Penpot you can design libraries to share and reuse; turn design elements into components and tokens to allow reusability and scalability; and build realistic user flows and interactions.
<br />
2021-06-23 05:52:10 -05:00
<p align="center">
2024-04-08 04:49:56 -05:00
<img src="https://img.plasmic.app/img-optimizer/v1/img?src=https%3A%2F%2Fimg.plasmic.app%2Fimg-optimizer%2Fv1%2Fimg%2F9dd677c36afb477e9666ccd1d3f009ad.png" alt="Open Source" style="width: 65%;">
</p>
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
<br />
2021-06-23 05:52:10 -05:00
## Getting started ##
2021-06-23 05:52:10 -05:00
### Install with Elestio ###
2024-04-08 04:49:56 -05:00
Penpot is the only design & prototype platform that is deployment agnostic. You can use it or deploy it anywhere.
2021-06-23 05:52:10 -05:00
2024-04-08 06:13:56 -05:00
Learn how to install it with Elestio and Docker, or other options on [our website](https://penpot.app/self-host).
2024-04-08 04:49:56 -05:00
<br />
2016-11-20 14:08:24 -05:00
2021-06-23 05:52:10 -05:00
<p align="center">
2024-04-08 04:49:56 -05:00
<img src="https://site-assets.plasmic.app/2168cf524dd543caeff32384eb9ea0a1.svg" alt="Open Source" style="width: 65%;">
2021-06-23 05:52:10 -05:00
</p>
2024-04-08 04:49:56 -05:00
<br />
2021-06-23 05:52:10 -05:00
## Community ##
2017-03-01 04:54:37 -05:00
2024-04-08 04:49:56 -05:00
We love the Open Source software community. Contributing is our passion and if its yours too, participate and [improve](https://community.penpot.app/c/help-us-improve-penpot/7) Penpot. All your designs, code and ideas are welcome!
2017-03-01 04:54:37 -05:00
2022-09-19 01:42:52 -05:00
If you need help or have any questions; if youd like to share your experience using Penpot or get inspired; if youd rather meet our community of developers and designers, [join our Community](https://community.penpot.app/)!
2016-11-20 14:08:24 -05:00
2022-09-19 01:42:52 -05:00
You will find the following categories:
- [Ask the Community](https://community.penpot.app/c/ask-for-help-using-penpot/6)
- [Troubleshooting](https://community.penpot.app/c/technical/8)
- [Help us Improve Penpot](https://community.penpot.app/c/help-us-improve-penpot/7)
- [#MadeWithPenpot](https://community.penpot.app/c/madewithpenpot/9)
- [Events and Announcements](https://community.penpot.app/c/announcements/5)
- [Inside Penpot](https://community.penpot.app/c/inside-penpot/21)
- [Penpot in your language](https://community.penpot.app/c/penpot-in-your-language/12)
2024-04-08 04:49:56 -05:00
- [Design and Code Essentials](https://community.penpot.app/c/design-and-code-essentials/22)
<br />
2021-06-23 05:52:10 -05:00
<p align="center">
<img src="https://github.com/penpot/penpot/assets/5446186/6ac62220-a16c-46c9-ab21-d24ae357ed03" alt="Community" style="width: 65%;">
</p>
2024-04-08 04:49:56 -05:00
<br />
## Contributing ##
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
Any contribution will make a difference to improve Penpot. How can you get involved?
Choose your way:
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
- Create and [share Libraries & Templates](https://penpot.app/libraries-templates.html) that will be helpful for the community
- Invite your [team to join](https://design.penpot.app/#/auth/register)
2024-04-08 04:49:56 -05:00
- Star this repo and follow us on Social Media: [Mastodon](https://fosstodon.org/@penpot/), [Youtube](https://www.youtube.com/c/Penpot), [Instagram](https://instagram.com/penpot.app), [Linkedin](https://www.linkedin.com/company/penpotdesign), [Peertube](https://peertube.kaleidos.net/a/penpot_app) and [X](https://twitter.com/penpotapp).
- Participate in the [Community](https://community.penpot.app/) space by asking and answering questions; reacting to others articles; opening your own conversations and following along on decisions affecting the project.
- Report bugs with our easy [guide for bugs hunting](https://help.penpot.app/contributing-guide/reporting-bugs/) or [GitHub issues](https://github.com/penpot/penpot/issues)
- Become a [translator](https://help.penpot.app/contributing-guide/translations)
2024-04-08 10:28:10 -05:00
- Give feedback: [Email us](mailto:support@penpot.app)
2023-09-28 00:28:56 -05:00
- **Contribute to Penpot's code:** [Watch this video](https://www.youtube.com/watch?v=TpN0osiY-8k) by Alejandro Alonso, CIO and developer at Penpot, where he gives us a hands-on demo of how to use Penpots repository and make changes in both front and back end
2021-06-23 05:52:10 -05:00
To find (almost) everything you need to know on how to contribute to Penpot, refer to the [contributing guide](https://help.penpot.app/contributing-guide/).
2021-06-23 05:52:10 -05:00
2024-04-08 04:49:56 -05:00
<br />
<p align="center">
2024-04-08 04:49:56 -05:00
<img src="https://github.com/penpot/penpot/assets/5446186/fea18923-dc06-49be-86ad-c3496a7956e6" alt="Libraries and templates" style="width: 65%;">
</p>
2019-09-21 07:02:32 -05:00
2024-04-08 04:49:56 -05:00
<br />
## Resources ##
2021-02-01 04:58:19 -05:00
2021-06-23 05:52:10 -05:00
You can ask and answer questions, have open-ended conversations, and follow along on decisions affecting the project.
2021-02-01 04:58:19 -05:00
💾 [Documentation](https://help.penpot.app/technical-guide/)
🚀 [Getting Started](https://help.penpot.app/technical-guide/getting-started/)
✏️ [Tutorials](https://www.youtube.com/playlist?list=PLgcCPfOv5v54WpXhHmNO7T-YC7AE-SRsr)
2023-04-14 15:12:59 -05:00
🏘️ [Architecture](https://help.penpot.app/technical-guide/developer/architecture/)
📚 [Dev Diaries](https://penpot.app/dev-diaries.html)
2021-02-01 04:58:19 -05:00
2016-11-20 14:08:24 -05:00
## License ##
```
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
2021-03-30 07:47:52 -05:00
Copyright (c) KALEIDOS INC
2016-11-20 14:08:24 -05:00
```
Penpot is a Kaleidos [open source project](https://kaleidos.net/)