diff --git a/README.md b/README.md index 3611ac2..0ceaa8d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # Chronos ![GitHub deployments](https://img.shields.io/github/deployments/binaryshrey/chronos/production?style=flat&logo=vercel&label=vercel) +A minimalistic Kanban board app : project management and issue tracking for everyone - [View](https://chronos-inc.vercel.app/) + +![Banner](https://raw.githubusercontent.com/binaryshrey/Chronos/main/chronos-product.png) + +### Development setup + +``` +git clone https://github.com/binaryshrey/Chronos.git +cd Portfolio +npm i +npm run start +``` + +Create a .env file for Firebase +``` +REACT_APP_FIREBASE_API_KEY=********** +REACT_APP_FIREBASE_AUTHDOMAIN=**********.firebaseapp.com +REACT_APP_FIREBASE_PROJECTID=********** +REACT_APP_FIREBASE_STORAGE_BUCKET=**********.appspot.com +REACT_APP_FIREBASE_MESSAGESENDER_ID=********** +REACT_APP_FIREBASE_APPID=********** +REACT_APP_FIREBASE_MEASUREMENTID=********** +``` + + +Development server runs at `http://localhost:3000`. + + + + + +