Connect My Family

A small open source project to connect familes trapped/affected by the Sikkim flood.

Installation locally

To run the Connect My Family project locally, follow these steps:

1. Install NodeJs, MongoDB on your machine.
2. Clone the project repository.
3. Navigate to the project directory.
4. Create .env.local file in the root folder and copy paste the content of .env.sample, and add necessary credentials.
5. Install the packages:

npm install

6. Run the project:

npm run dev

7. Access the project

How to contribute - Guidelines

I welcome your interest in contributing to our open source project!

To contribute to Connect My Family, please follow these steps:

1. Fork the repository.

2. Create a new branch for your feature or bug fix: git checkout -b feat/your-feature-name or git checkout -b fix/your-bug-fix-name.

3. Make your changes and commit them using conventional commit messages: git commit -am "feat: Add new feature". For more details on the commit format and other guidelines, please refer to the Contributor Guidelines.

4. Push your changes to your forked repository: git push origin feat/your-feature-name.

5. Submit a pull request to the main repository, explaining the changes you've made and providing any necessary details.