Contributing guidelines

Getting started

If it is your first time working on this project, it is recommended to start working on issues labelled "First Timers Only".
Choose an issue that is labelled "Available" and claim it in the comment section of the respective issue.
Once the maintainer of the repository assigns it to you, you can start working on it.
Make sure you keep updating us on your work.

Fork this repository by clicking fork button
Clone the repository in your local machine by typing
```
git clone https://github.com/<your-username>/Activity-Tracker.git
```
in your terminal(for mac/linux) or Git Bash (for windows)
Now create a new branch using
```
git checkout -b <your-new-branch-name>
```

Install nodejs and npm on your local machine. For windows, linux and mac
Windows users need to install Visual Studio Build Tools with Desktop development with C++ workload checked. (Please note that this is different from Visual Studio Code) Download Visual Studio Build Tools.
Mac users need to install Xcode Command Line Tools by running
```
xcode-select –install
```
Install pnpm by opening your terminal with administrative (sudo) privileges and type
```
npm i -g pnpm
```
Open your terminal in your current working directory (i.e, Activity-Tracker) and run the following command to install all dependencies for the project
```
pnpm i
```

Navigate to Activity-Tracker directory and type
```
pnpm run dev
```
If you get an error, type these commands
```
pnpm dlx rimraf node_modules
```
```
pnpm install
```
Now start the application by running
```
pnpm run dev
```
Open http://localhost:3001/ in a browser and enter. At this address, the web application will be running

If you want to use MongoDB (instead of the default JSON storage), you can either:

Download MongoDB locally. Linux user can use these steps for MongoDB installation.

OR
Install wsl on your machine, only for [windows] (https://docs.microsoft.com/en-us/windows/wsl/install) and also download ubuntu from microsoft store. wsl and ubuntu installation is not required for windows 10 pro.
Install docker on your machine. We are using docker container to run MongoDB so that it remains isolated from rest of the system and is easy to setup. For windows, linux and mac.
Install docker-compose by following the official guide. docker-compose is already installed when using docker desktop for Windows/macOS.
Navigate to Activity-Tracker directory and with administrative privileges run
```
docker-compose up -d
```

If you face any issues while setting up feel free to ask the moderators in issues and if you are new to open source refer to this link

You can find a step-by-step proceducre on how to create a PR here
While raising a pull request from your branch, please follow the PR-name-style-guide.
While submitting your PR, please follow this template