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
Copy file name to clipboardExpand all lines: docs/src/content/docs/guides/setup.mdx
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,29 +28,38 @@ It also helps to have some basic familiarity with the command line, Git, HTML, C
28
28
29
29
Click the "Fork" button on the top right of the [`namesake` repository](https://github.com/namesakefyi/namesake/) to create your own copy of the repository.
30
30
31
+
<details>
32
+
<summary>Why do I have to do this?</summary>
33
+
The `namesakefyi/namesake` repository only allows people on the Namesake core team to create new branches and push changes. In order to propose changes, **you need to make edits on your _own_ copy** ("fork") of the repository. Once you've made your changes, you propose merging them back into the main repository with a **pull request**.
34
+
</details>
35
+
31
36
2. Clone your fork.
32
37
38
+
Open your terminal and paste this line (updating `MY_USERNAME` to your own GitHub username), then press `enter` to run it:
You should now have a `namesake` folder on your computer.
46
+
You should now have a `namesake` folder on your computer. Open the folder in your code editor and take a look around!
40
47
41
48
## Start the development server
42
49
43
50
<Steps>
44
51
45
-
1.From the `namesake` directory, install packages.
52
+
1.Navigate to the `namesake` directory from your terminal, then install packages.
46
53
47
54
```bash
55
+
cd namesake
48
56
pnpm install
49
57
```
50
58
51
-
:::tip{icon="pnpm"}
52
-
If you get **`error command not found: pnpm`**, [make sure pnpm is installed](https://pnpm.io/installation).
53
-
:::
59
+
<details>
60
+
<summary>I'm getting `error command not found: pnpm`</summary>
61
+
You need to install `pnpm`, the package manager we use. Follow the `pnpm`[installation guide](https://pnpm.io/installation). If you get stuck, reach out on Discord!
62
+
</details>
54
63
55
64
If this is your first time installing packages, it may take awhile to download everything.
56
65
@@ -66,7 +75,7 @@ You should now have a `namesake` folder on your computer.
66
75
67
76
</Steps>
68
77
69
-
You should now be able to see the Namesake website at [http://localhost:4321](http://localhost:4321)! Changes will automatically refresh in your browser as you make edits to the code.
78
+
You should now be able to see the Namesake website at [http://localhost:4321](http://localhost:4321)! Changes will automatically refresh in your browser as you edit and save the code.
70
79
71
80
Leave this process running in the background while you work on the codebase. To stop the server, press `Ctrl + C` in the terminal.
0 commit comments