README.md

legend-studio

The codebase and home of Legend applications: Legend Studio, Legend Query, etc.

Getting started

Studio relies Legend SDLC server and Legend Engine server. To quickly set these backend servers up, use our development Docker compose. If you need to debug and develop the backend, setup with Maven instead.

Last but not least, make sure you have Yarn installed. Run the following commands in order.

  yarn install
  yarn setup
  yarn dev

After setting up, visit http://localhost:9000/studio and the application should be up 🎉

If you get Unauthorized error, visit SDLC server at http://localhost:6100/api/auth/authorize in your browser, you will get redirected to the Gitlab login page or a Gitlab page asking you to authorize Legend OAuth application. After you completing these steps, you will be redirected back to SDLC. Now refresh Studio and the problem should be gone.

Documentation

You can find the usage documentation on the website.

Check out the Getting Started page for a quick overview. Also check out the Installation Guide to find out how to setup your Legend ecosystem.

You can improve it by sending pull requests to this repository.

For Legend Studio extension contributors, check out our API documentation.

Roadmap

Visit our roadmap to know more about the upcoming features.

Contributing

Please read our contributing guide.

Code of conduct

We adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Good first issues

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

License

Copyright (c) 2020-present, Goldman Sachs

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0