1.2 KiB
1.2 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
- TypeScript, HTML, SCSS - even just knowing basic JS and CSS will give you familiarity of the code
- Astro - Astro is the chosen framework, please read throught the basics on their docs if you are unfamiliar
- we don't use any framework that ships to the browser, we only write Astro components for server-side rendering, and vanilla DOM manipulation via
script
tags.
- @extractus/article-extractor - Article Extractor is the library we use to fetch and extract article content
Setting up the project
- Clone
git clone https://github.com/ayoayco/cozy.git
- install dependencies
cd cozy
npm install
- 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