github.com/yourbase/yb@v0.7.1/README.md (about)

     1  <h1><img alt="YourBase" src="https://github.com/yourbase/docs.yourbase.io/raw/main/images/logo-on-white.jpg" width="384" height="112"></h1>
     2  
     3  [![YourBase Community Slack](https://img.shields.io/badge/slack-@yourbase/community-blue.svg?logo=slack)](https://slack.yourbase.io)
     4  
     5  `yb build all-the-things!`
     6  
     7  YourBase is a build tool that makes working on projects much more delightful. Stop worrying
     8  about dependencies, keep your CI build process in-sync with your local
     9  development process and onboard new team members with ease.
    10  
    11  The primary features of the YB tooling are:
    12  
    13  * *Consistent local and CI tooling* How a project is built as part of the
    14    CI/CD process should not be any different than how it is built on a
    15    developer's machine. Keeping tooling in-sync means predictable results and 
    16    a better developer experience for everyone. (Although local builds are not 
    17    fully isolated yet)
    18  
    19  * *Accelerated on-boarding* Many projects have long sets of instructions that 
    20    are required for a developer to get started. With YB, the experience is as 
    21    simple as getting source code and running `yb build` - batteries included!
    22  
    23  * *Programmatic dependency management* No need to have developers manually
    24    install and manage different versions of Go, Node, Java, etc. By describing
    25    these tools in codified build-packs, these can be installed and configured 
    26    automatically on a per-project basis. Manage containers and other runtime 
    27    dependencies programmatically and in a consistent manner. 
    28  
    29  * *Remote builds* Run your work and tests in the cloud just like you would 
    30    locally or as part of CI! Stream the results back to your machine in real-time
    31    to offload the work.
    32  
    33  ![magic!](http://www.reactiongifs.com/r/mgc.gif)
    34  
    35  ## Installation
    36  
    37  yb is available for Mac via Homebrew, and Linux/WSL2 via `apt-get`.
    38  Instructions are available at https://docs.yourbase.io/installation.html
    39  
    40  ## Getting Started
    41  
    42  To use yb, you need a `.yourbase.yml` file at the top of your project directory.
    43  You can run `yb init` to generate one:
    44  
    45  ```shell
    46  cd path/to/my/project
    47  yb init
    48  yb build
    49  ```
    50  
    51  For a more in-depth tutorial, see https://docs.yourbase.io/getting-started.html
    52  
    53  ## Documentation
    54  
    55  Documentation is available at [docs.yourbase.io/cli](https://docs.yourbase.io/cli/)
    56  
    57  ## Contributing 
    58  
    59  We welcome contributions to this project! Please see the [contributor's guide][]
    60  for more information. 
    61  
    62  [contributor's guide]: CONTRIBUTING.md
    63  
    64  ## License 
    65  
    66  This project is licensed under an [Apache 2.0 license](LICENSE.md).