cozy/CONTRIBUTING.md
2023-06-04 20:48:59 +02:00

1.1 KiB

Contributing to Cozy

Thank you for your interest in building the coziest web experience for people like you and me.

Tech Stack

This project is built with the following tech

  1. Astro - Astro is the chosen framework, please read throught the basics on their docs if you are unfamiliar
  2. Vite - Vite is the bundler Astro is using and it allows us to do server-side rendering
  3. @extractus/article-extractor - Article Extractor is the library we use to fetch and extract article content

Setting up the project

  1. Clone
git clone https://github.com/ayoayco/cozy.git
  1. install dependencies
cd cozy
npm install
  1. run the dev server
npm start

Good first issues

Go to our issues page to watch out for issues we label as "good first issue" or "help wanted"

Code of Conduct

Our CODE OF CONDUCT follows the Contributor Covenant