7d0aeeefe5
* Improve format and clarity of the docs [ci skip] While this change produces a lot of git noise by enacting what seems like an arbitrary linewrap on most of the files in the documentation it will result in better version control and tracking of the changes in the documentation. For example, as it currently stands, if one was to make a PR to move a comma in a sentence because each paragraph in most of the files is on a single line, that small change would look in the git history like the author had modified the entire paragraph. In reality, this author just moved a comma. This change also includes a significant number of modifications to the more article-esque docs. Many of these docs were written in a sort of stream-of-conciousness and aren't as easy to read as they could be. Hopefully this is the first of several readability changes. If we could get these docs to a more accessible reading level, we would probably see an increase in contributions. :) * Delegate markdown wrapping to Prettier * Add linewrapping explanation in the docs [ci skip]
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
---
|
|
title: Starting the Application
|
|
---
|
|
|
|
# Starting the application
|
|
|
|
We're a Rails app, and we use [Webpacker][webpacker] to manage some of our
|
|
JavaScript.
|
|
|
|
Start the application, Webpack, and our job runner [delayed_job][delayed_job] by
|
|
running:
|
|
|
|
```shell
|
|
bin/startup
|
|
```
|
|
|
|
(This just runs `foreman start -f Procfile.dev`)
|
|
|
|
Then point your browser to http://localhost:3000/ to view the site.
|
|
|
|
If you're working on DEV regularly, you can use `alias start="bin/startup"` to
|
|
make this even easier. 😊
|
|
|
|
If you're using **`pry`** for debugging in Rails, note that using `foreman` and
|
|
`pry` together works, but it's not as clean as `bin/rails server`.
|
|
|
|
Here are some singleton commands you may need, usually in a separate
|
|
instance/tab of your shell.
|
|
|
|
- Running the job server (if using `bin/rails server`) -- this is mostly for
|
|
notifications and emails: **`bin/rails jobs:work`**
|
|
- Clearing jobs (in case you don't want to wait for the backlog of jobs):
|
|
**`bin/rails jobs:clear`**
|
|
|
|
Current gotchas: potential environment issues with external services need to be
|
|
worked out.
|
|
|
|
[delayed_job]: https://github.com/collectiveidea/delayed_job_active_record
|
|
[webpacker]: https://github.com/rails/webpacker
|