diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9922dc4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing to Cozy + +Thank you for your interest to help bring the coziest web experience to people like you and me. + +## Tech Stack + +This project is built with the following tech +1. HTML, CSS, TypeScript +1. [Astro](https://astro.build) +1. [@extractus/article-extractor](https://www.npmjs.com/package/@extractus/article-extractor) + +## Setting up the project + +1. Clone + +``` +git clone https://github.com/ayoayco/cozy-reader.git +``` + +2. install dependencies + +``` +cd cozy-reader +npm install +``` + +3. run the dev server + +``` +npm start +``` + +## Good first issues + +Go to our [issues page](https://github.com/ayoayco/cozy-reader/issues) to watch out for issues we label as "good first issue" or "help wanted"