UXBOX
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!
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.
Development
Most of the main operations can be done through the helper script manage.sh
.
The development requires of UXBOX is done through a single docker container. Each main service is opened in a different tmux sessions.
Docker
Docker is also used to build release images for backend and frontend. Use the helper script manage.sh
to build the images.
You can run locally UXBOX through a docker-compose or by manually running the containers.
Complementary to the docker images you can build locally from this repository, you can find additionnal flavors for backend and frontend on external repositories:
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/postgresql/data
PostgreSQL Data
$ docker run -d \
-v db:/var/lib/postgresql/data \
postgresql
You also need to persist the UXBOX backend public resources (media and assets) to not lose images uploaded and allow the frontend to expose assets.
/srv/uxbox/resources/public
UXBOX backend public resources
$ docker run -d \
-v db:/srv/uxbox/resources/public \
monogramm/docker-uxbox-backend
Auto configuration via environment variables
The following environment variables are also honored for configuring your UXBOX instance:
Frontend
Only available at build time!
-e UXBOX_API_URL=...
(defaults to/api
)-e UXBOX_VIEW_URL=...
(defaults to/view/
)-e UXBOX_DEMO=...
(not defined, setting any value will activate demo mode)-e UXBOX_DEBUG=...
(not defined, setting any value will activate debug mode)
Available at runtime:
-e LANG=...
(defaults toen_US.UTF-8
)-e LC_ALL=...
(defaults toC.UTF-8
)
Backend
Available at runtime:
-e LANG=...
(defaults toen_US.UTF-8
)-e LC_ALL=...
(defaults toC.UTF-8
)-e UXBOX_HTTP_SERVER_PORT=...
(defaults to6060
)-e UXBOX_HTTP_SERVER_DEBUG=...
(defaults totrue
)-e UXBOX_DATABASE_USERNAME="..."
(defaults tonil
)-e UXBOX_DATABASE_PASSWORD="..."
(defaults tonil
)-e UXBOX_DATABASE_NAME="..."
(defaults to"uxbox"
)-e UXBOX_DATABASE_SERVER="..."
(defaults to"localhost"
)-e UXBOX_DATABASE_PORT=...
(defaults to5432
)-e UXBOX_MEDIA_DIRECTORY=...
(defaults toresources/public/media
)-e UXBOX_MEDIA_URI=...
(defaults tohttp://localhost:6060/media/
)-e UXBOX_ASSETS_DIRECTORY=...
(defaults toresources/public/static
)-e UXBOX_ASSETS_URI=...
(defaults tohttp://localhost:6060/static/
)-e UXBOX_EMAIL_REPLY_TO="..."
(defaults to[email protected]
)-e UXBOX_EMAIL_FROM="..."
(defaults to[email protected]
)-e UXBOX_SUPPORT_EMAIL="..."
(defaults to[email protected]
)-e UXBOX_SMTP_HOST="..."
(defaults to"localhost"
)-e UXBOX_SMTP_PORT=...
(defaults to25
)-e UXBOX_SMTP_USER="..."
(defaults tonil
)-e UXBOX_SMTP_PASSWORD="..."
(defaults tonil
)-e UXBOX_SMTP_SSL=...
(defaults tofalse
)-e UXBOX_SMTP_TLS=...
(defaults tofalse
)-e UXBOX_SMTP_ENABLED=...
(defaults tofalse
)-e UXBOX_REGISTRATION_ENABLED=...
(defaults totrue
)-e UXBOX_SECRET="..."
(defaults to"5qjiAndGY3"
)
Important note: make sure to use quotation marks for string variables or the backend might try to interpret the values as symbols and have weird issues.
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
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/.