Skip to content

Commit 2ccfb17

Browse files
committed
Add recent changes to Local Setup Guides
1 parent 333690a commit 2ccfb17

2 files changed

Lines changed: 16 additions & 6 deletions

File tree

docs/LOCAL_SETUP.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,7 @@ rake db:setup
181181

182182
### Start CodeHarbor
183183

184-
For the development environment, three server processes are required:
185-
the Rails server for the main application, a Webpack server providing JavaScript and CSS assets
186-
and the Solid Queue supervisor to process background jobs.
184+
For the development environment, three server processes are required: the Rails server for the main application, a Webpack server providing JavaScript and CSS assets, and the Solid Queue supervisor to process background jobs.
187185

188186
1. Webpack dev server:
189187

@@ -209,6 +207,8 @@ This will launch the CodeHarbor web application server on port 7500 (default set
209207
bundle exec rake solid_queue:start
210208
```
211209

210+
This will launch the Solid Queue supervisor to process background jobs.
211+
212212
**Check with:**
213213
Open your web browser at <http://localhost:7500>
214214

docs/LOCAL_SETUP_VAGRANT.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Vagrant setup
22

3-
With the Vagrant-based setup, you won't need to (manually) install CodeHarbor and all dependencies on your local instance. Instead, a virtual machine containing all requirements will be configure
3+
With the Vagrant-based setup, you won't need to (manually) install CodeHarbor and all dependencies on your local instance. Instead, a virtual machine containing all requirements will be configured.
44

55
## Install VirtualBox
66

@@ -73,15 +73,15 @@ During the first start, Vagrant will run a provision script and automatically se
7373

7474
## Start CodeHarbor
7575

76-
For the development environment with Vagrant, two server processes are required: the Rails server for the main application, and a Webpack server providing JavaScript and CSS assets. As those processes will be run in the virtual machine, you always need to connect to the VM with `vagrant ssh`.
76+
For the development environment with Vagrant, three server processes are required: the Rails server for the main application, a Webpack server providing JavaScript and CSS assets, and the Solid Queue supervisor to process background jobs. As those processes will be run in the virtual machine, you always need to connect to the VM with `vagrant ssh`.
7777

7878
1. Webpack dev server:
7979

8080
This project uses [shakapacker](https://github.com/shakacode/shakapacker) to integrate Webpack with Rails to deliver Frontend assets. During development, the `webpack-dev-server` automatically launches together with the Rails server if not specified otherwise. In case of missing JavaScript or stylesheets and for Hot Module Reloading in the browser, you might want to start the `webpack-dev-server` manually *before starting Rails*:
8181

8282
```shell
8383
vagrant ssh
84-
cd codeocean
84+
cd codeharbor
8585
yarn run webpack-dev-server
8686
```
8787

@@ -97,6 +97,16 @@ This will launch a dedicated server on port 3045 (default setting) and allow inc
9797

9898
This will launch the CodeHarbor web application server on port 7500 (default setting) for all interfaces (`0.0.0.0`) and allow incoming connections from your browser. Listening on all interfaces is required, so that you can connect from your VM-external browser to the Rails server.
9999

100+
3. Solid Queue supervisor:
101+
102+
```shell
103+
vagrant ssh
104+
cd codeharbor
105+
bundle exec rake solid_queue:start
106+
```
107+
108+
This will launch the Solid Queue supervisor to process background jobs.
109+
100110
**Check with:**
101111
Open your web browser at <http://localhost:7500>. Vagrant will redirect requests to your `localhost` automatically to the virtual machine.
102112

0 commit comments

Comments
 (0)