Skip to content

UofA-Blueprint/strata

Repository files navigation

🏗️ Strata - The Design System Built For Blueprint

Welcome to Strata!

📄 Description

The Strata serves as a centralized source of identity for Blueprint. The repository contains source code for all Strata components, and an interactive user experience that serves as a showcase for our brand.

🚀 Steps to Start Contributing

Follow these steps to set up and contribute to the project:

1. Install Node

To build and run the website locally, you'll need to install Node. Do this by visiting the official Node download page, or use nvm (Recommended).

2. Clone the Repository

git clone <repository-url>
cd <repository-folder>

3. Install Node Packages (Dependencies)

npm i

4. Branch from main

# from main
git switch -c 123-your-branch

NOTE: Make sure to append the ticket number from notion to the start of the branch name.

5. Develop locally

Run the following command to start a local server to see changes during development:

npm run dev

6. Commit changes

Save completed work by creating organized commits, this is done via the following command:

git add <file-path>
git commit -m "summary message"

TIP: Use the commit message emoji guide, Gitmoji, to provide reviewers with visual context in commit messages (for example, ":recycle: refactored navbar").

7. Push changes to GitHub

Run:

git push

... to sync your branch to GitHub. If this is your first push on a fresh branch you will need to run the command that git suggests after running the previous command, it should look something like this:

git push --set-upstream origin 123-your-branch

8. Request a review

Once your changes are committed and pushed to GitHub, request a Code Review from two authorized team members. This is done by navigating to GitHub directly after pushing the branch and clicking Compare & pull request at the top of the page.

Once a pull request is created, add a detailed description of the changes made, click assign yourself under Assignees, and select two reviewers from the team under Reviewers. If you are unsure of who to assign, please post a question in the Discord channel.

NOTE: A pull request may be denied if there is a missing/unacceptable description. Please provide the reviewer with some context.

About

Reusable UI component library built with `shadcn/ui`, designed for consistent styling and rapid development across Blueprint Club projects.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors