penpot/README.md


[uri_license]: https://www.mozilla.org/en-US/MPL/2.0
[uri_license_image]: https://img.shields.io/badge/MPL-2.0-blue.svg

[![License: MPL-2.0][uri_license_image]][uri_license]
[![Build Status](https://travis-ci.org/Monogramm/uxbox.svg)](https://travis-ci.org/Monogramm/uxbox)
[![Docker Automated buid](https://img.shields.io/docker/build/monogramm/uxbox.svg)](https://hub.docker.com/r/monogramm/uxbox/)
[![Docker Pulls](https://img.shields.io/docker/pulls/monogramm/uxbox.svg)](https://hub.docker.com/r/monogramm/uxbox/)

# UXBOX #

![UXBOX](https://piweek.com/images/projects/uxbox.jpg)

## Introduction ##

The open-source solution for design and prototyping. UXBOX is currently at an early development stage but we are working hard to bring you the beta version as soon as possible. Follow the project progress in Twitter or Github and stay tuned!

[See SVG specification](https://www.w3.org/Graphics/SVG/)

## SVG based ##

UXBOX works with SVG, a standard format, for all your designs and prototypes . This means that all your stuff in UXBOX is portable and editable in many other vector tools and easy to use on the web.

## Persistent data
The UXBOX installation and all data are stored in the database (file uploads, etc). The docker daemon will store that data within the docker directory `/var/lib/docker/volumes/...`. That means your data is saved even if the container crashes, is stopped or deleted.

To make your data persistent to upgrading and get access for backups is using named docker volume or mount a host folder. To achieve this you need one volume for your database container.

Database:
- `/var/lib/mysql` MySQL / MariaDB Data
- `/var/lib/postgresql/data` PostgreSQL Data
```console
$ docker run -d \
    -v db:/var/lib/postgresql/data \
    postgresql
```

## Contributing ##

**Open to you!**

We love the open source software community. Contributing is our passion and because of this, we'll be glad if you want to participate and improve UXBOX. All your awesome ideas and code are welcome!

Please refer to the [Contributing Guide](./CONTRIBUTING.md)


## 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/.
```
Update README.md 2018-10-24 15:55:29 -05:00
:memo: Update README tags 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`

			`[![License: MPL-2.0][uri_license_image]][uri_license]`
			`[![Build Status](https://travis-ci.org/Monogramm/uxbox.svg)](https://travis-ci.org/Monogramm/uxbox)`
:memo: Update README 2019-02-14 07:07:13 -05:00			`[![Docker Automated buid](https://img.shields.io/docker/build/monogramm/uxbox.svg)](https://hub.docker.com/r/monogramm/uxbox/)`
			`[![Docker Pulls](https://img.shields.io/docker/pulls/monogramm/uxbox.svg)](https://hub.docker.com/r/monogramm/uxbox/)`
Update README.md 2018-10-24 15:55:29 -05:00
Import docker related files. 2016-11-20 14:08:24 -05:00			`# UXBOX #`

new readme 2017-03-01 04:58:57 -05:00			`![UXBOX](https://piweek.com/images/projects/uxbox.jpg)`
new readme 2017-03-01 04:54:37 -05:00
Import docker related files. 2016-11-20 14:08:24 -05:00			`## Introduction ##`

new readme 2017-03-01 04:54:37 -05:00			`The open-source solution for design and prototyping. UXBOX is currently at an early development stage but we are working hard to bring you the beta version as soon as possible. Follow the project progress in Twitter or Github and stay tuned!`

			`[See SVG specification](https://www.w3.org/Graphics/SVG/)`

			`## SVG based ##`
Import docker related files. 2016-11-20 14:08:24 -05:00
new readme 2017-03-01 04:54:37 -05:00			`UXBOX works with SVG, a standard format, for all your designs and prototypes . This means that all your stuff in UXBOX is portable and editable in many other vector tools and easy to use on the web.`
Import docker related files. 2016-11-20 14:08:24 -05:00
:memo: Update README 2019-02-14 07:07:13 -05:00			`## Persistent data`
			The UXBOX installation and all data are stored in the database (file uploads, etc). The docker daemon will store that data within the docker directory `/var/lib/docker/volumes/...`. That means your data is saved even if the container crashes, is stopped or deleted.

			`To make your data persistent to upgrading and get access for backups is using named docker volume or mount a host folder. To achieve this you need one volume for your database container.`

			`Database:`
			- `/var/lib/mysql` MySQL / MariaDB Data
			- `/var/lib/postgresql/data` PostgreSQL Data
			```console
			`$ docker run -d \`
			`-v db:/var/lib/postgresql/data \`
			`postgresql`
			```

Update contributing guide and the readme. 2017-02-24 13:25:11 -05:00			`## Contributing ##`
Import docker related files. 2016-11-20 14:08:24 -05:00
new readme 2017-03-01 04:54:37 -05:00			`Open to you!`

			`We love the open source software community. Contributing is our passion and because of this, we'll be glad if you want to participate and improve UXBOX. All your awesome ideas and code are welcome!`

			`Please refer to the [Contributing Guide](./CONTRIBUTING.md)`
Import docker related files. 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/.`
			```