github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/docs/quickstart/index.md (about)

     1  ---
     2  title: ⭐ Quickstart
     3  description: A hands-on quickstart for lakeFS that introduces key concepts including branching, merging, and rollback. 
     4  nav_order: 1
     5  has_children: true
     6  has_toc: false
     7  next: ["Launch the quickstart environment", "./launch.html"]
     8  redirect_from: 
     9    - /quickstart.html
    10    - /quickstart/installing.html
    11    - /quickstart/try.html
    12    - /quickstart/add_data.html
    13    - /quickstart/more_quickstart_options.html
    14    - /quickstart/repository.html
    15    - /quickstart/run.html
    16    - /quickstart/first_commit.html
    17  ---
    18  
    19  # lakeFS Quickstart
    20  
    21  **Welcome to lakeFS!**
    22  
    23  lakeFS provides a "Git for data" platform enabling you to implement best practices from software engineering on your data lake, including branching and merging, CI/CD, and production-like dev/test environments. 
    24  
    25  This quickstart will introduce you to some of the core ideas in lakeFS and show what you can do by illustrating the concept of branching, merging, and rolling back changes to data. It's laid out in five short sections: 
    26  
    27  
    28  <div class="quickstart-steps">
    29  
    30  <div class="row">
    31  <div class="col step-num">
    32  <img src="{{ site.baseurl }}/assets/img/quickstart/quickstart-step-01.png" alt="step 1"/>
    33  </div>
    34  <div class="col">
    35  <h3>
    36  <a href="launch.html">Launch</a>
    37  </h3>
    38  <p>Spin up the quickstart environment locally under Docker</p>
    39  </div>
    40  </div>
    41  
    42  <div class="row">
    43  <div class="col step-num">
    44  <img src="{{ site.baseurl }}/assets/img/quickstart/quickstart-step-02.png" alt="step 2"/>
    45  </div>
    46  <div class="col">
    47  <h3>
    48  <a href="query.html">Query</a>
    49  </h3>
    50  <p>Query the pre-populated data on the `main` branch</p>
    51  </div>
    52  </div>
    53  
    54  <div class="row">
    55  <div class="col step-num">
    56  <img src="{{ site.baseurl }}/assets/img/quickstart/quickstart-step-03.png" alt="step 3"/>
    57  </div>
    58  <div class="col">
    59  <h3>
    60  <a href="branch.html">Branch</a>
    61  </h3>
    62  <p>Make changes to the data on a new branch</p>
    63  </div>
    64  </div>
    65  
    66  <div class="row">
    67  <div class="col step-num">
    68  <img src="{{ site.baseurl }}/assets/img/quickstart/quickstart-step-04.png" alt="step 4"/>
    69  </div>
    70  <div class="col">
    71  <h3>
    72  <a href="commit-and-merge.html">Merge</a>
    73  </h3>
    74  <p>Merge the changed data back to the `main` branch</p>
    75  </div>
    76  </div>
    77  
    78  <div class="row">
    79  <div class="col step-num">
    80  <img src="{{ site.baseurl }}/assets/img/quickstart/quickstart-step-05.png" alt="step 5"/>
    81  </div>
    82  <div class="col">
    83  <h3>
    84  <a href="rollback.html">Rollback</a>
    85  </h3>
    86  <p>Change our mind and revert the changes</p>
    87  </div>
    88  </div>
    89  </div>
    90  
    91  <div class="row">
    92  <div class="col step-num">
    93  <img src="{{ site.baseurl }}/assets/img/quickstart/quickstart-step-06.png" alt="step 6"/>
    94  </div>
    95  <div class="col">
    96  <h3>
    97  <a href="actions-and-hooks.html">Actions</a>
    98  </h3>
    99  <p>Use Actions to trigger code when an event occurs</p>
   100  </div>
   101  </div>
   102  
   103  <div class="row">
   104  <div class="col step-num">
   105  <img src="{{ site.baseurl }}/assets/img/quickstart/quickstart-step-07.png" alt="step 6"/>
   106  </div>
   107  <div class="col">
   108  <h3>
   109  <a href="work-with-data-locally.html">Work Locally</a>
   110  </h3>
   111  <p>Experiment with lakeFS data on a local environment</p>
   112  </div>
   113  </div>
   114  
   115  {: .note}
   116  You can use the [30-day free trial of lakeFS Cloud](https://lakefs.cloud/register) if you want to try out lakeFS without installing anything.