Skip to content

Latest commit

 

History

History
110 lines (91 loc) · 4.69 KB

README.md

File metadata and controls

110 lines (91 loc) · 4.69 KB
Raw

Sampark 🙏

Our initiative aims to improve the lives of underprivileged communities by addressing health, sanitation, education, and empowerment. Our volunteers collect data on specific needs, which is stored in a Google spreadsheet and updated in our Firebase database. We collaborate with NGOs and raise funds through our Sampark website to provide necessary items. College teams help distribute these items while also conducting classes for slum children. We prioritize empowerment, collaboration, and community involvement to bring about positive change. Join us in making a lasting impact on the lives of those in need.

Checkout our Work at Sampark LIVE



Installation

Using Docker-Compose

Simply run

docker-compose up

this will set up the Firebase emulator along with the application in a development environment.

Local Setup

Firebase Emulator Setup To set up the firebase emulator, run:

make emulator

Application Setup Then run the project locally by:

  1. Install all the required dependencies using npm install.
  2. Run the program locally using npm run dev.

Contributing⚡

We welcome contributions from anyone who is interested in improving this project. If you'd like to contribute, here are some ways you can get started:

  • Submit a bug report if you find any issues with the application.
  • Suggest new features or improvements.
  • Submit a pull request to fix a bug or add a feature after an issue is assigned to you.

To submit a pull request, please follow these steps:

  1. Fork this repository.
  2. Clone the forked repository.
git clone https://github.com/<your-github-username>/sampark
  1. Navigate to the project directory.
cd sampark
  1. Create a new branch.
git checkout -b <your_branch_name>
  1. Make changes.
  2. View and review your changes locally before pushing it.
  3. Stage your changes and commit.
git add -A
git commit -m "<your_commit_message>"
  1. Push your local commits to the remote repo.
git push -u origin <your_branch_name>
  1. Create a pull request from your branch to the original repository.
  2. Congratulations! 🎉 you've made your contribution.

We will review your pull request and provide feedback. Once your changes are approved, we will merge them into the main branch. At last after successfully merge of a pull request you can view your work live at Sampark LIVE

If you're interested in working on any of the issues, please let us know by submitting an issue or reaching out to us.


Code of Conduct

Contributors are expected to adhere to the following Code of Conduct to ensure a positive and inclusive environment for collaboration


Contributors🎉