Skip to content

Commit

Permalink
Create Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShinichiShi authored Dec 21, 2024
1 parent 8c56a23 commit 0ec58c1
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## How to Run Locally

### Clone the repository:
```bash
git clone https://github.com/ShinichiShi/KrishiSeva.git
cd KrishiSeva
```
2. Create a env.local in client repository accordingly:
```bash
VITE_FIREBASE_API_KEY=xxx
VITE_FIREBASE_AUTH_DOMAIN=xxx
VITE_FIREBASE_PROJECT_ID=xxx
VITE_FIREBASE_STORAGE_BUCKET=xxx
VITE_FIREBASE_MESSAGING_SENDER_ID=xxx
VITE_FIREBASE_APP_ID=xxx
```
Contact any of the maintainers for the contents of the `.env.local` file

Then, run in the client folder terminal:
```bash
cd client
npm install
npm run dev
```
and along with that:
```bash
cd server
npm install
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

# Contributing

We welcome contributions to KrishiSeva! Here’s how you can help:

1. Fork the repository.
2. Raise any issue
3. Create a feature branch:
```bash
git checkout -b feature-name
```
4. Commit your changes:
```bash
git commit -m 'Add feature-name'
```
5. Push to the branch:
```bash
git push origin feature-name
```
6. Open a pull request.

---
## Contributors

- [**Supreeth C**](https://github.com/ShinichiShi)
- [**Vaibhav Garg**](https://github.com/vaibhavgarg25)
- [**Samyak SH**](https://github.com/Samyak-SH)
- [**Lavi**](https://github.com/Nexusrex18)
- [**Dilip SC**](https://github.com/DilipSC)
- [**Isha Rajmohan**](https://github.com/IshaRajmohan)

0 comments on commit 0ec58c1

Please sign in to comment.