diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ddc2db0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +First of all, Thank you very much for taking interest on this repository. Your good intention to contribute is very appreciated. + +This is a monorepo for the project masjid-network. It contains code for both Frontend and Backend. you can find the code on each respective folder. + +When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. + +### Frontend + +For frontend, we use the `frontend` folder. Here is the step to contribute for the first timers: + +- cd into `frontend` folder +- Type `npm install` into your terminal (make sure you have node and npm installed) +- after installing dependencies, you can start the project in development mode with `npm run dev` \ No newline at end of file