Site settings
Change the appearance of the site to suit your preferences
How to contribute
Spor is a collaborative effort between all development teams at Vy. Our goal is to create consistent and accessible user experiences—both for our customers and employees. We work openly, so anyone inside (or outside) Vy can contribute!
This guide will walk you through setting up the project, understanding the repository, and how you can start contributing.
📂 Repository Overview
Spor follows a monorepo structure, meaning it contains multiple packages and applications.
🚀 Applications
docs– A Remix app for documentation and demos (this site).studio– A Sanity Studio app for managing documentation (spor.vy.no/studioEkstern lenke).
📦 Key Packages
@vygruppen/spor-react– The React component library.@vygruppen/spor-design-tokens– Design tokens (colors, typography, spacing, etc.).@vygruppen/spor-icon– SVG icons.@vygruppen/spor-icon-react– React components for icons.@vygruppen/spor-icon-react-native– React Native components for icons.@vygruppen/spor-loader- All Lottie loading animation data
🚀 Getting Started
🔧 Prerequisites
Before you begin, make sure you have:
✅ Node.js installed.
✅ Basic familiarity with Git for version control.
📥 Cloning the Repository
git clone https://github.com/nsbno/spor.git
📦 Installing Dependencies
Navigate to the project directory and install the required dependencies:
cd spornpm install
⚡ Building the Project
Before running the project, some assets (like icons) need to be built. Running the command below will generate a local dist folder, making them available.
npm run build
💻 Running the Development Server
Start the project in development mode:
npm run dev
🤝 The Spirit of Collaboration
Spor exists to help developers and designers build consistent, accessible, and high-quality interfaces.
While the core team maintains the system, most new development happens in product teams. That means:
💡 Need a new component? Build it and submit a pull request!
🐞 Found a bug? Fix it, or create a GitHub issue so others can help.
📚 Think the documentation is unclear? Update it or suggest improvements!
At Vy, everyone can and should contribute to Spor—so that the efforts of one benefit the entire organization. Have questions? Reach out in the #spor channel on Slack!
👋 How Can You Contribute?
There are many ways to contribute, big or small! Here are some ideas:
🛠 Develop new components, features, or bug fixes.
🎨 Design new components and propose design improvements.
📝 Enhance documentation by adding examples or proofreading.
🔍 Increase test coverage by writing more tests.
🐛 Report bugs or suggest improvements via GitHub issues.
💬 Provide feedback on design and developer experience.
✅ Review pull requests and help maintain code quality.
Every contribution—no matter how small—makes a difference! 🚀
🔎 Getting Started with Your First Contribution
To make contributing easier, here are some step-by-step guides for common tasks:
1️⃣ Creating a New React Component
2️⃣ Component Best Practises
3️⃣ Creating a New React Native Component
If you're unsure where to start, check out GitHub issues labeled good first issue for beginner-friendly tasks.