Skip to content

Commit 0182239

Browse files
authored
Merge pull request webdevcody#681 from grewal25/update-docs
add step to fix docker error
2 parents 4bc7784 + 96122e8 commit 0182239

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ You will need to [install docker](https://www.docker.com/get-started/) on your l
2828

2929
If you do not have docker, go here to download and install: <https://www.docker.com/get-started/>
3030

31+
If you see error starting db on M1 mac, you may need to update your docker config file at `~/.docker/config.json`
32+
Your file should look like something like this:
33+
34+
```
35+
{
36+
"auths": {},
37+
"currentContext": "desktop-linux"
38+
}
39+
```
40+
3141
If you are getting WSL error when you launch your desktop docker application, go here and follow these steps for windows: <https://learn.microsoft.com/en-us/windows/wsl/install-manual#step-4---download-the-linux-kernel-update-package>.
3242

3343
## Installation
@@ -74,9 +84,9 @@ To get started with Code Racer locally, follow these steps
7484

7585
10. Start the web socket server
7686

77-
```sh
78-
npm run dev:wss
79-
```
87+
```sh
88+
npm run dev:wss
89+
```
8090

8191
Open your browser and visit <http://localhost:3000> to see the application running.
8292

@@ -89,7 +99,6 @@ There is also a new video explaining how you can contribute to this project:
8999
<br/>
90100
[How to contribute to open source projects (our community project walkthrough)](https://www.youtube.com/watch?v=dLRA1lffWBw)
91101

92-
93102
If you want to work on a new feature, follow these steps.
94103

95104
1. Fork the repo
@@ -113,7 +122,9 @@ git pull upstream main
113122
```
114123

115124
## Before Submitting a Pull Request
125+
116126
Before submitting a **Pull Request**, you should
127+
117128
1. Check your code safety with Linter and TypeScript, and make sure your code can build successfully.
118129

119130
```sh
@@ -125,6 +136,7 @@ npm run pr:precheck
125136
```
126137
npm run e2e -w @code-racer/app
127138
```
139+
128140
## Code of Conduct
129141

130142
### Our Pledge

0 commit comments

Comments
 (0)