39 lines
838 B
Markdown
39 lines
838 B
Markdown
# 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"
|
|
|
|
## Code of Conduct
|
|
|
|
Our [CODE OF CONDUCT](/CODE_OF_CONDUCT.md) follows the [Contributor Covenant](https://www.contributor-covenant.org)
|