1# Stretch
2[![CircleCI](https://circleci.com/gh/vislyhq/stretch.svg?style=svg)](https://circleci.com/gh/vislyhq/stretch)
3[![Cargo](https://img.shields.io/crates/v/stretch.svg)](https://crates.io/crates/stretch)
4
5Stretch is an implemnetation of Flexbox written in [Rust](https://www.rust-lang.org). The goal of stretch is to provide a solid foundation for layout across all platforms with a specific focus on mobile. Long term we want stretch to not only support flexbox but also many other layout algorithms such as grid layout. Stretch was made for and powers https://visly.app.
6
7## Goals
8Before using or contributing to stretch it is good to be aware of the core goals of the project. These are goals we are working towards, not necessarily features we currently support.
9
10- High performance
11- Cross platform
12- Small binary size
13- Support multiple layout systems
14- Multi-threaded layout
15- Language bindings for most common languages
16
17## Usage
18Stretch is still in its initial development phase so we currently don't publish any artifacts to package managers. If you want to use stretch today or start contributing to the development of stretch you will need to build it locally.
19
20### Installation
21If you don't have rust installed you have to do that first as well as install some components that we make use of to format and lint the codebase. For more on rust see their [website](https://www.rust-lang.org).
22
23```bash
24curl https://sh.rustup.rs -sSf | sh
25rustup component add rustfmt
26rustup component add clippy
27```
28
29Once that is done you can clone the repo and do some sanity checks to make sure everything is working correctly.
30
31```bash
32git clone https://github.com/vislyhq/stretch.git
33cd stretch
34cargo test
35```
36
37### Testing
38Stretch is tested by validating that layouts written in stretch perform the same as in Chrome. This is done by rendering an equivalent layout in HTML and then generating a rust test case which asserts that the resulting layout is the same when run through stretch.
39
40You can run these tests without setting up a webdriver environment but if you are looking to add any test case you will need to install [chromedriver](http://chromedriver.chromium.org). If you are developing on macOS this is easy to do through brew.
41
42```bash
43brew tap homebrew/cask
44brew cask install chromedriver
45```
46
47Once you have chromedriver installed and available in `PATH` you can re-generate all tests by running `cargo run --package gentest`.
48
49To add a new test case add another HTML file to `/test_fixtures` following the current tests as a template for new tests.
50
51## Contributing
52Contributions are very welcome. Though we ask that you open an issue or pull request early in the process (before writing code) so we can discuss solutions and additions before you start spending time on implementing them. There are some specific areas where we would be extra happy to receive contributions in.
53
54- Binary size reduction
55- Runtime performance
56- Ensure build / test environment works well on non macOS platforms
57- Alternate layout systems (grid layout perhaps?)
58- Web compatibility tests
59- RTL support
60- Platform bindings
61
62## Relationship to Yoga
63[Yoga](https://www.yogalayout.com) is a cross-platform implementation of Flexbox written in C. Yoga is a fantastic project but has some fundamental issues which we hope to resolve. Compared to Yoga we aim to have a stronger adherence to web standards, a flexible architecture eventually supporting multiple layout algorithms, and future performance improvements including multi-threaded layout. In addition to this we aim to use a safer language with a more modern codebase.
64
65# LICENCE
66```
67Copyright (c) 2018 Visly Inc.
68
69Permission is hereby granted, free of charge, to any person obtaining a copy
70of this software and associated documentation files (the "Software"), to deal
71in the Software without restriction, including without limitation the rights
72to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
73copies of the Software, and to permit persons to whom the Software is
74furnished to do so, subject to the following conditions:
75
76The above copyright notice and this permission notice shall be included in all
77copies or substantial portions of the Software.
78
79THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
80IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
81FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
82AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
83LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
84OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
85SOFTWARE.
86```