README.md

Zuri Chat Company Shift Plugin

---

Overview
Company Shift Management Plugin for Zuri Chat.

Live URL:

EmployeeShift

Tech Stack:

• React js
• Node js

Dev Setup Instruction

1. Install Node.js, Yarn, Git
2. Clone repo using git clone https://github.com/zurichat/zc_plugin_company_shift.git
3. Change directory cd zc_plugin_company_shift
4. Run local installations in different folders and start the server:
   client: cd client
yarn install
yarn start
   server: cd server
yarn install
yarn run dev

Contributing to the Repo Guide

1. Fork the repository

2. Clone the repository

3. Open project folder in your preferred terminal & set the upstream branch: git remote add upstream https://github.com/zurichat/zc_plugin_company_shift.git

4. Pull from upstream branch git pull upstream dev

5. Create a new branch for the feature/chore/fix you wish to work on. eg : git checkout -b my-feature-branch

6. To install a package, change directory into the desired project folder,
   cd client or
   cd server

7. Run yarn add --exact package-name for core dependency
   yarn add -D --exact package-name for devDependency

8. Make your changes and commit,
   git add .
git commit -m "my wonderful magical code implementation"

9. Check for conflicts before pushing : git pull upstream dev
   If conflicts exist, please fix it before pushing

10. Push changes : git push origin my-feature-branch

11. Create a pull request to the dev branch. Please not the main branch