Skip to content

Commit d9a11b9

Browse files
Docs for devs
1 parent dd8750a commit d9a11b9

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

docs/developers/setup.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,38 @@
44
- [Ruby](https://www.ruby-lang.org/en/downloads/) (>= 3.0.0) - Don't know how to install? Follow our [guide](../install-ruby.md)
55
- [Bundler](https://bundler.io/) - Don't know how to install? Follow our [guide](../install-ruby.md)
66
- [Node.JS](https://nodejs.org/en/) (>= 19.0.0)
7+
- [GIT](https://git-scm.com/downloads)
8+
9+
## Optional Tools
10+
- If on Windows, [Git Bash](https://git-scm.com/downloads) is recommended (for running the commands)
711

812
## Setup
913
1. Clone the repository
1014
```bash
1115
git clone https://github.com/ruby-network/ruby
1216
```
13-
2. Install the Ruby dependencies
17+
2. Setup Git
18+
```bash
19+
git update-index --assume-unchanged .bundle/config
20+
```
21+
3. Remove the .bundle directory
22+
```bash
23+
rm -rf .bundle
24+
```
25+
4. Install the Ruby dependencies
1426
```bash
1527
bundle install
1628
```
17-
3. Install the Node.JS dependencies
29+
5. Install the Node.JS dependencies
1830
```bash
1931
npm install
2032
```
2133

2234
## Running the app
23-
1. Run the Ruby server
24-
```bash
25-
bundle exec puma
26-
```
27-
This should also start the Node.JS server. If it doesn't, run the following command:
28-
```bash
29-
node index.js
35+
1. Run the Dev Server
36+
```bash
37+
yarn dev
3038
```
39+
- This should allow you to make changes to the code and see them live on the website.
40+
## Note:
41+
- If you are making changes to the Node Server, you will need to restart the server for the changes to take effect.

0 commit comments

Comments
 (0)