You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Run `npm i` in the root directory of the repository.
32
32
33
+
### Backend setup
34
+
35
+
- Start MongoDB server
36
+
- Run `npm install` to install all dependencies
37
+
- Make a `.env` file with all secrets. You also need to generate google client id and secret key. You may refer [to this](https://developers.google.com/identity/protocols/oauth2https://developers.google.com/adwords/api/docs/guides/authentication#create_a_client_id_and_client_secret) for the steps.
38
+
> Note: Put `<server_url>/api/auth/google/redirect` in redirect url when generating google client id and secret.
Copy file name to clipboardExpand all lines: README.md
+46-33Lines changed: 46 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,59 +1,70 @@
1
1
# TPC-website
2
+
2
3
This is the official website of the Programming Club at IIITDM Jabalpur
3
4
4
5
## Tech Stack
6
+
5
7
- Frontend - React
6
-
- Backend - Django
8
+
- Backend - Express (nodejs)
7
9
8
10
## Fixing issues
11
+
9
12
### Step 1: Pick an issue
13
+
10
14
After selecting an issue
15
+
11
16
1. Comment on the issue saying that you are working on the issue.
12
17
2. We expect you to discuss the approach by comments.
13
18
3. Updates or progress on the issue would be nice.
14
19
15
20
### Step 2: Follow branch policies
21
+
16
22
1. Create a new branch and switch to it (make sure you are on master before doing this).
17
-
```
18
-
git branch mybranch
19
-
git checkout mybranch
20
-
```
21
-
'mybranch' can be replaced by your preferred name for the branch or the issue for which it was created.
22
-
The above two commands are equivalent to the following
23
-
```
24
-
git checkout -b mybranch
25
-
```
23
+
24
+
```
25
+
git branch mybranch
26
+
git checkout mybranch
27
+
```
28
+
29
+
'mybranch' can be replaced by your preferred name for the branch or the issue for which it was created.
30
+
The above two commands are equivalent to the following
31
+
32
+
```
33
+
git checkout -b mybranch
34
+
```
26
35
27
36
2. Make your changes and then execute the tests to make sure you didn't break anything.
28
37
29
-
```
30
-
python3 manage.py test
31
-
```
32
-
Ensure that you follow [PEP8](https://www.python.org/dev/peps/pep-0008/#descriptive-naming-styles) style guide for python code while naming functions or classes.
38
+
```
39
+
python3 manage.py test
40
+
```
41
+
42
+
Ensure that you follow [PEP8](https://www.python.org/dev/peps/pep-0008/#descriptive-naming-styles) style guide for python code while naming functions or classes.
33
43
34
-
Then stage them and commit them.
35
-
Check out Chris Beams's guide to writing good commit messages [here](https://chris.beams.io/posts/git-commit/).
44
+
Then stage them and commit them.
45
+
Check out Chris Beams's guide to writing good commit messages [here](https://chris.beams.io/posts/git-commit/).
36
46
37
-
*A small description of your changes is must in the commit messages.*
47
+
_A small description of your changes is must in the commit messages._
38
48
39
49
3. After you are done making changes, push the branch to your fork.
40
-
```
41
-
git push -u myfork mybranch
42
-
```
43
-
The **-u** option is required only the first time you push the branch.
50
+
```
51
+
git push -u myfork mybranch
52
+
```
53
+
The **-u** option is required only the first time you push the branch.
44
54
45
-
Make sure your branch is up-to-date with the latest version of the master. Else you are required to do a rebase to place your changes above master branch.
55
+
Make sure your branch is up-to-date with the latest version of the master. Else you are required to do a rebase to place your changes above master branch.
46
56
47
57
### Step 3: Follow Coding policy
48
58
49
-
1. Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
50
-
2. Single commit per pull request
51
-
3. For writing commit messages please adhere to the Commit style guidelines.
52
-
4. Follow uniform design practices.
53
-
5. The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
54
-
6. If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
59
+
1. Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
60
+
2. Single commit per pull request
61
+
3. For writing commit messages please adhere to the Commit style guidelines.
62
+
4. Follow uniform design practices.
63
+
5. The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
64
+
6. If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
55
65
56
66
### Step 4: Submitting a Pull request
67
+
57
68
Once a PR is opened, try and complete it within 2 weeks, or at least stay actively working on it. Inactivity for a long period may necessitate a closure of the PR. As mentioned earlier updates would be nice.
58
69
59
70
### Step 5: Code Review
@@ -63,16 +74,18 @@ Your code will be reviewed, by :
63
74
1. Reviewer: A core team member will review your pull request and approve it or he will suggest changes.
64
75
65
76
### Step 6: Help us by reviewing other Pull Requests!
77
+
66
78
If you have the time and the knowledge then you must review other Pull Requests. This would stop Pull Requests from stacking up and will definitely mean your Pull Request would be reviewed faster.
67
79
68
80
**Things to keep in mind while reviewing a Pull Request:**
69
81
70
82
If any of the following questions has a **YES** for an answer then the request shall **NOT** be approved.
71
-
* Will the referenced issue **NOT** be fixed with the Pull Request?
72
-
* Is the commit message **NOT** good?
73
-
* Are there unnecessary changes?
74
-
* Is a rebase required?
75
-
* Is the fix dirty / hacky?
83
+
84
+
- Will the referenced issue **NOT** be fixed with the Pull Request?
0 commit comments