aurgy

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Getting Started

Aurgy is a monorepo. Our javascript set up is run primarily for our web services. We use lerna to manage our javascript packages.

Lerna is a tool to help dependency management for larger scale repositories. It fits into our current model as a tool to help us create a distinct, yet interdependent web of shared packages.

Read this blog post to learn more about the benefits and challenges of using a monorepo.

Prerequisites

Below are the prerequisites for Aurgy:

Node Requirements

We use yarn as our package manager. Run nvm use to get the right version.

node v16

We use yarn as our package manager.

Step One

The basic commands to get this repository and start are:

$ git clone https://github.com/UCLA-Creative-Labs/aurgy.git
$ cd aurgy
$ yarn

If you run into an issue, feel free to make an issue here. If you have a fix, even better! Check out the follow section to learn how to contribute!

Contributing

Thanks for your interest in contributing to aurgy! ❤️

Here's a quick guide on how to get started.

1. Fork the repository or checkout a branch; main is protected and is managed through our pipeline.
2. Create an issue and/or mark an existing one to let everyone know that you are working your magic ⚡️
3. Beep boop away!
4. Before you push, it's always a good idea to check that your changes follow our linter rules! Run yarn lint at the root directory and watch it judge your code.
5. Stage, commit, and push your changes to make a pull request!
6. A maintainer will review your code and if it passes all the checks, your contribution will be merged on to main 🥳

See CONTRIBUTING.md and DESIGN_GUIDELINES.md for more info.

Getting Help

If you ever need help with a feature or bug fix, no worries! Feel free to mark the issue as guidance so that our maintainers can start thinking about a solution. If you are comfortable making a draft pull request, you can also tag the Creative Labs team in a comment: @UCLA-Creative-Labs/team!

License

MIT