Skip to content

Commit 25f141d

Browse files
authored
Create Contribution.md
1 parent cafb120 commit 25f141d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

Contribution.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<h1 align="center">Contribution guidelines</h1>
2+
3+
To contibute to this project, [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo and clone it on your local machine.
4+
5+
Navigate to the [server](./server) and [web](./web) folder and run `yarn` in your terminal in each folder.
6+
7+
To start the server, you need to configure environments by adding `.env` file in `server` folder and `.env.local` in `web` folder. You can refer to `.env.example` in each folder.
8+
9+
To start the backend server locally, navigate to `/server` and run `yarn watch` followed by `yarn dev`. You should now able to access *raphql playground* locally on [http://localhost:4000/graphql](http://localhost:4000/graphql)
10+
11+
To start the frontend server locally, navigate to `/web` and run `yarn dev`.
12+
13+
After proposing a feature or fixing a bug, create a Pull Request targetting to the [main](https://github.com/Nazeeh21/Meshare/tree/main) branch of this repo.

0 commit comments

Comments
 (0)