-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8c56a23
commit 0ec58c1
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |