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
{{ message }}
This repository was archived by the owner on Mar 9, 2021. It is now read-only.
*[Coderplex](https://github.com/coderplex/coderplex) : Frontend of the application
28
32
33
+
*[Coderplex-Backend](https://github.com/coderplex/coderplex-backend) : Backend of the application
29
34
30
35
## Code of Conduct
36
+
31
37
Coderplex has adopted [Contributor Covenant](https://github.com/coderplex/coderplex/blob/develop/.github/CODE_OF_CONDUCT.md) that we expect project participants to adhere to.
32
38
33
39
## Open Development
40
+
34
41
All work related to the application takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and to engage open source contributors. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management tool. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both core team members and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way.
35
42
36
43
## Branching Model
37
-
The `master` branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for that particular branch i.e any changes in that branch gets reflected in [https://coderplex.org](https://coderplex.org).
38
-
It is highly recommended for both maintainers and contributors to raise a pull request to `develop` branch. Before every release we throughly test develop branch and merge into master.
44
+
45
+
The `master` branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for that particular branch i.e any changes in that branch gets reflected in [https://coderplex.org](https://coderplex.org). It is highly recommended for both maintainers and contributors to raise a pull request to `develop` branch. Before every release we throughly test develop branch and merge into master.
46
+
39
47
40
-
<br/>
41
-
*A pull request to any other branch may most likely be closed by our bots.*
48
+
49
+
_A pull request to any other branch may most likely be closed by our bots_.
42
50
43
51
## Development Workflow
44
52
45
53
We welcome pull requests from beginners and seasoned javaScript developers alike!
46
54
47
55
### Work on Issues
48
-
1. Find an issue that needs assistance by searching for the [open issues](https://github.com/coderplex/coderplex/labels/help-wanted).
49
-
2. If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
50
-
3. If somebody claims an issue but doesn’t follow up for more than a weeks, it’s fine to take over it but you should still leave a comment.
51
56
57
+
1. Find an issue that needs assistance by searching for the [open issues](https://github.com/coderplex/coderplex/labels/help-wanted).
58
+
1. If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
59
+
1. If somebody claims an issue but doesn’t follow up for more than a weeks, it’s fine to take over it but you should still leave a comment.
52
60
53
61
### Proposing a Change
62
+
54
63
1. Open a new issue if you would like report a bug or suggest improvements.
55
-
2. Please wait for core team members to comment on the thread. This lets us reach an agreement on your proposal before you put significant effort into it.
64
+
1. Please wait for core team members to comment on the thread. This lets us reach an agreement on your proposal before you put significant effort into it.
56
65
57
66
### Prerequisites
67
+
58
68
1.[NodeJS](https://nodejs.org/)
59
-
<br/>
60
-
Minimum version v8.0.0+
61
-
```bash
62
-
To check node version
63
-
$ node -v
64
-
```
65
-
Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100).
66
-
> If you face problem updating your node then you might need a Node version manager tool. [Follow here]()
67
-
68
-
2. [Yarn](https://yarnpkg.com)
69
-
<br/>
70
-
Minimum version v1.2.0+
71
-
<br/>
72
-
Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab).
73
-
Use yarn over npm
74
-
> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file.
75
-
76
-
3. [Git](https://git-scm.com/download/linux)
77
-
<br/>
78
-
Familiarity with git is mandatory.
69
+
70
+
* Minimum version v8.0.0+
71
+
72
+
```bash
73
+
To check node version
74
+
node -v
75
+
```
76
+
77
+
Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100).
78
+
79
+
> If you face problem updating your node then you might need a Node version manager tool. [Follow here](#1-node-version-manager)
80
+
81
+
1.[Yarn](https://yarnpkg.com)
82
+
83
+
* Minimum version v1.2.0+
84
+
* Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab). Use yarn over npm
85
+
86
+
> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file.
87
+
88
+
1.[Git](https://git-scm.com/download/linux) (Familiarity with git is mandatory).
79
89
80
90
### Sending a Pull Request
81
91
@@ -85,88 +95,100 @@ We welcome pull requests from beginners and seasoned javaScript developers alike
85
95
86
96
1. Fork the [repository](https://github.com/coderplex/coderplex).
87
97
1. Then clone your forked repository
88
-
```bash
89
-
$ git clone <your forked repository url>
90
-
```
98
+
```bash
99
+
git clone <your forked repository url>
100
+
```
91
101
1. Move to the repository root folder
92
-
```bash
93
-
$ cd coderplex
94
-
```
102
+
```bash
103
+
cd coderplex
104
+
```
95
105
1. Install dependencies
96
-
```bash
97
-
$ yarn
98
-
```
106
+
```bash
107
+
yarn
108
+
```
99
109
1. Start the development server
100
-
```bash
101
-
$ yarn dev
102
-
```
103
-
App now opens at `localhost:3000` in your default browser.
104
-
> You may get this [error]() if any other app is already running the above port.
110
+
```bash
111
+
yarn dev
112
+
```
113
+
App now opens at `localhost:3000` in your default browser.
114
+
> You may get this [error](#2-local-host-occupied) if any other app is already running the above port.
115
+
116
+
#### Before submitting
105
117
106
-
#### Before submitting:
107
118
1. From your fork, create a [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) and name it. eg. `typo-in-readme`
108
119
1. If you’ve fixed a bug or added code that should be tested, add tests!
109
120
1. Ensure that all test pass
110
-
```bash
111
-
$ yarn test
112
-
```
121
+
```bash
122
+
yarn test
123
+
```
113
124
1. Run code formatters
114
-
```bash
115
-
$ yarn lint
116
-
```
125
+
```bash
126
+
yarn lint
127
+
```
117
128
1. Add and commit your code. Please give meaning full commit messages.
118
-
1. Pull latest code from [upstream repository's](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`develop`, ifincase anything new were merged while you were working on your fork.
129
+
1. Pull latest code from [upstream repository's](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`develop`, if in case anything new were merged while you were working on your fork.
119
130
1. Push the code to your fork.
120
-
1. Raise the pull request from your created branch to `develop` branch of coderplex. [why develop instead of master branch?]()
131
+
1. Raise the pull request from your created branch to `develop` branch of coderplex. [why develop instead of master branch?](https://www.atlassian.com/git/tutorials/comparing-workflows)
121
132
1. Take some time to give a brief description of the work you have done.
122
133
123
134
#### After submitting
135
+
124
136
1. Wait for all checks to pass in below section.
125
-
2. Your changes are deployed with a unique link `https://deploy-preview-xx--coderplex.netlify.com`. <br/>
126
-
*`- xx` is your pull request number.*
127
-
3. The core team will review your pull request and either merge it, request changes to it, or close it with an explanation.
137
+
1. Your changes are deployed with a unique link `https://deploy-preview-xx--coderplex.netlify.com`.
138
+
139
+
_`- xx` is your pull request number._
140
+
141
+
1. The core team will review your pull request and either merge it, request changes to it, or close it with an explanation.
128
142
129
143
##### Received a review request
130
-
- Work on the requested changes
131
-
- Push the changes as you did earlier, the pull request will automatically catch those and update itself.
144
+
145
+
* Work on the requested changes
146
+
* Push the changes as you did earlier, the pull request will automatically catch those and update itself.
*Make sure you have [curl](https://curl.haxx.se/) installed*
156
173
157
-
###### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows
174
+
_Make sure you have [curl](https://curl.haxx.se/) installed_
175
+
176
+
#### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows
177
+
158
178
It comes with an [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades).
159
179
160
180
```bash
161
181
Install particular version
162
-
$ nvm install 8.9.1
182
+
nvm install 8.9.1
163
183
164
184
Use installed version
165
-
$ nvm use 8.9.1
185
+
nvm use 8.9.1
166
186
```
167
-
Still facing problem this [article](https://medium.com/appseed-io/how-to-run-multiple-versions-of-node-js-with-nvm-for-windows-ffbe5c7a2b47) from [@skounis ](https://twitter.com/skounis) explain in details.
168
187
169
-
##### 2. Local host occupied
188
+
Still facing problem this [article](https://medium.com/appseed-io/how-to-run-multiple-versions-of-node-js-with-nvm-for-windows-ffbe5c7a2b47) from [@skounis](https://twitter.com/skounis) explain in details.
at process._tickCallback (internal/process/next_tick.js:188:7)
180
202
error Command failed with exit code 1.
181
203
```
204
+
182
205
If you get this error while running `yarn dev` then probably another app is occupying `localhost:3000`. You may want to close that and run the command again.
[](https://greenkeeper.io/)[](https://github.com/sindresorhus/xo)[](https://github.com/prettier/prettier)[](https://travis-ci.org/coderplex/coderplex)[](https://github.com/coderplex/coderplex/blob/master/LICENSE)
8
4
9
-
##### Join our community here at https://www.coderplex.org
10
-
>:construction: under active development
5
+
## Join our community here at [https://www.coderplex.org](https://www.coderplex.org)
6
+
7
+
> :construction: under active development
11
8
12
9
## About
13
10
14
11
This project mainly uses
15
12
16
-
*[ReactJS](https://reactjs.org/) - A declarative, efficient, and flexible JavaScript library for building user
17
-
interfaces.
13
+
*[ReactJS](https://reactjs.org/) - A declarative, efficient, and flexible JavaScript library for building user interfaces.
18
14
*[Next.js](https://github.com/zeit/next.js/) - A minimalistic framework for server-rendered React applications.
19
15
*[emotion](https://emotion.sh) - A high performance, lightweight css-in-js library.
20
16
21
-
22
17
## Contributing
23
18
24
-
We welcome pull requests from beginners and seasoned javaScript developers alike!. You can work on open issues, fix bugs
25
-
and more. Be sure to read our [contributing guide](https://github.com/coderplex/coderplex/blob/develop/.github/CONTRIBUTING.md) for
26
-
hassel free contribution. <br/> This project follows ✨
27
-
[All Contributors](https://github.com/kentcdodds/all-contributors) ✨ specifications to recognize all contributors.
19
+
We welcome pull requests from beginners and seasoned javaScript developers alike!. You can work on open issues, fix bugs and more. Be sure to read our [contributing guide](https://github.com/coderplex/coderplex/blob/develop/.github/CONTRIBUTING.md) for hassel free contribution.
20
+
21
+
This project follows ✨ [All Contributors](https://github.com/kentcdodds/all-contributors) ✨ specifications to recognize all contributors.
0 commit comments