README.md

Sterczące Uszy

"Sterczące Uszy" is a non-profit organization that helps animals in difficult situations.

This repo contains the design system and the entire website for the organization.

Live page × Storybook

Table of Contents 📃

• Getting Started
• Project Structure
• Contributing

Getting Started 🚀

Clone the repo:

git clone https://github.com/non-profit-dev/sterczace-uszy.git

and then:

cd website # go to the project's directory
yarn # install all required dependencies
yarn develop # run local server at `localhost:3000`
yarn storybook # start Storybook at `localhost:6006`

⚠️

If you want to run the project, make sure to reach out to me (@imklau) on GitHub. I'll hook you up with all the required envs!

Project structure 🧩

This project consists of 3 different packages, with the following structure:

packages/
├── shared
├── design-system
  ├── tokens
  ├── components
  ├── patterns
  ├── blocks
  └── helpers
└── frontend
  ├── app
  └── e2e

Each package comes with its own README.md file. Feel free to check them out for more info!

Contributing 🤝

This project is a pro bono effort, and we are constantly learning and improving as we work on it.

If you're interested in contributing to our project, please feel free to reach out to us!