ayo/cozy
ayo/cozy
1
Fork 0
Code Issues 2 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Create CONTRIBUTING.md

Browse source
This commit is contained in:
Ayo Ayco 2023-05-29 10:38:52 +02:00 committed by GitHub
parent ab902745b2
commit ae585d8389
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
CONTRIBUTING.md Normal file
View file

@ -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"