Skip to content

Commit

Permalink
feat: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Gaurav-Verma07 committed Jun 4, 2023
2 parents 9be2baf + 3a6c5ab commit 454c466
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 18 deletions.
69 changes: 63 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@

## Introduction
<div align="center">
<!----------------------Introduction Section---------------------->
<p align="center">
<h1 align="center">Sampark 🙏</h2>
<p>Our initiative aims to improve the lives of underprivileged communities through 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.</p>
<h2 align="center" >Checkout our Work at <a href="https://sampark-nine.vercel.app/">Sampark LIVE </a></h2>
<div align="center">
<img src="https://forthebadge.com/images/badges/built-with-love.svg" />
<img src="https://forthebadge.com/images/badges/uses-brains.svg" />
<img src="https://forthebadge.com/images/badges/powered-by-responsibility.svg" />
Expand All @@ -15,11 +18,14 @@
<img src="https://img.shields.io/github/contributors/Gaurav-Verma07/sampark?style=for-the-badge" />
<img src="https://img.shields.io/github/stars/Gaurav-Verma07/sampark?style=for-the-badge" />
</div>
</p>
<br>

![Samplark Logo](https://github.com/Gaurav-Verma07/sampark/blob/main/public/sampark-logo-transparent.png?raw=true)
<!-- ![Samplark Logo](https://github.com/Gaurav-Verma07/sampark/blob/main/public/sampark-logo-transparent.png?raw=true)-->
<!-- A social platform to connect NGOs and orphanage to potential social suppliers including schools and colleges. -->


A social platform to connect NGOs and orphanage to potential social suppliers including schools and colleges.
<!----------------------Contribution Section---------------------->

## Installation
### Using Docker-Compose
Expand All @@ -45,8 +51,59 @@ Then run the project locally by:
1. Install all the required dependencies using `npm install`.
2. Run the program locally using `npm run dev`.

<br>
<h2>Contributing⚡</h2>

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.
```css
git clone https://github.com/<your-github-username>/sampark
```
3. Navigate to the project directory.
```py
cd sampark
```
4. Create a new branch.
```css
git checkout -b <your_branch_name>
```
5. Make changes.
6. View and review your changes locally before pushing it.
7. Stage your changes and commit.
```css
git add -A
git commit -m "<your_commit_message>"
```
8. Push your local commits to the remote repo.
```css
git push -u origin <your_branch_name>
```
9. Create a pull request from your branch to the original repository.
10. Congratulations! 🎉 you've made your contribution.
<br>

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 <a href="https://sampark-nine.vercel.app/">Sampark LIVE </a>

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

<br>
<h2 align="center">Code of Conduct</h2>
Contributors are expected to adhere to the following Code of Conduct to ensure a positive and inclusive environment for collaboration
<br><br>

<!----------------------Contributors Section---------------------->

## Contributors
<br>
<h2 align="center">Contributors🎉</h2>
<p align="center">
<a href="https://github.com/Gaurav-Verma07/sampark/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Gaurav-Verma07/sampark" />
Expand Down
15 changes: 3 additions & 12 deletions src/components/MapBox/MapBox.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
import { AspectRatio, Button, Card, Paper, Text, Title } from '@mantine/core';
import { useMemo, useState } from 'react';
import Map, {
FullscreenControl,
GeolocateControl,
Marker,
NavigationControl,
Popup,
ScaleControl,
} from 'react-map-gl';
import Map, { FullscreenControl, GeolocateControl, Marker, NavigationControl, Popup, ScaleControl } from 'react-map-gl';

const cityData = [
{
Expand Down Expand Up @@ -80,10 +73,7 @@ const MapBox = () => {
alignItems: 'left',
}}
>
<Card
sx={{ display: 'flex', alignItems: 'left', flexDirection: 'column' }}
w="50%"
>
<Card sx={{ display: 'flex', alignItems: 'left', flexDirection: 'column' }} w="50%">
<Title order={1} weight={300}>
We provide assistanace. Register your NGO/orphanage at Sampark.
</Title>
Expand Down Expand Up @@ -121,6 +111,7 @@ const MapBox = () => {
width: '500px',
height: '100%',
borderRight: '10px',
boxShadow: '0px 4px 24px 0px #0909091A',
}}
mapStyle="mapbox://styles/mapbox/dark-v9"
mapboxAccessToken={import.meta.env.VITE_MAPBOX_ACCESS_TOKEN || ''}
Expand Down

1 comment on commit 454c466

@vercel
Copy link

@vercel vercel bot commented on 454c466 Jun 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.