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
-**Windows**: Use WSL2 with Ubuntu - follow [the MariaDB install guide from digital ocean](https://www.digitalocean.com/community/tutorials/how-to-install-mariadb-on-ubuntu-20-04#step-1-installing-mariadb)
46
+
47
+
-**Linux/Ubuntu**: Follow [the MariaDB install guide from digital ocean](https://www.digitalocean.com/community/tutorials/how-to-install-mariadb-on-ubuntu-20-04#step-1-installing-mariadb)
48
+
- Alternative (Docker): with docker installed run `mise docker-db` to start
49
+
the DB only (after cloning the repo)
50
+
48
51
3. Clone the project and switch to its directory
49
52
4. Run `mise setup`
50
53
5. Run `mise server` and visit <http://localhost:3000/> to see the AWBW portal page.
@@ -63,7 +66,7 @@ For Docker-based development (recommended):
63
66
64
67
## Credentials
65
68
66
-
These credentials also work for staging:
69
+
These credentials also work for [staging](https://awbw-staging-xzek4.ondigitalocean.app/):
@@ -76,22 +79,17 @@ These credentials also work for staging:
76
79
77
80
[](https://codespaces.new/rubyforgood/awbw/tree/main?quickstart=1)
78
81
79
-
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/rubyforgood/awbw)
80
-
81
82
1. Create the container:
82
83
- To run the container on a Github VM, follow the Codespace link above. You can connect to the Codespace using VSCode or the VSCode web editor.
83
84
- Or follow instructions to [create a new Codespace.](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)
84
-
- To clone this repo and run the container locally, follow instructions to [install VSCode and Docker](https://code.visualstudio.com/docs/devcontainers/containers). Click the Dev Container link above. Don't forget to add a git remote pointing to your fork once the container is setup and you want to push changes.
85
-
2. Wait for the container to start. This will take a few (10-15) minutes since Ruby needs to be installed, the database needs to be created, and the `bin/setup` script needs to run
86
-
3. Run `bin/start`. On the Ports tab, visit the forwarded port 3000 URL marked as Application to see the AWBW portal page.
85
+
2. Wait for the container to start. This will take a few (10-15) minutes since Ruby needs to be installed, the database needs to be created, and the `mise setup` script needs to run
86
+
3. Run `mise server`. On the Ports tab, visit the forwarded port 3000 URL marked as Application to see the AWBW portal page.
87
87
4. Login as a sample user with the default [credentials](#credentials).
88
88
89
89
## Troubleshooting 👷🏼♀️
90
90
91
91
Please let us know by opening up an issue! We have many new contributors come through and it is likely what you experienced will happen to them as well.
92
92
93
-
-_"My RBENV installation didn't work!"_ - The rbenv repository provides a [rbenv-doctor script](https://github.com/rbenv/rbenv-installer#rbenv-doctor) to verify the installation and check if a ruby version is installed
94
-
95
93
# 🤝 Code Contribution Workflow
96
94
97
95
1.**Identify an unassigned issue**. Read more [here](#issues) about how to pick a good issue.
@@ -131,17 +129,8 @@ Users that are frequent contributors and are involved in discussion (join the sl
131
129
132
130
If starting server directly, via `rail s` or `rail console`, or built-in debugger in RubyMine, or running `bundle exec rspec path/to/spec.rb:line_no`, then you can use `binding.pry` to debug. Drop the pry where you want the execution to pause.
133
131
134
-
If starting via Procfile with `bin/start`, then drop a `binding.remote_pry` into the line where you want execution to pause at. Then run `pry-remote` in the terminal to connect to it.
135
-
<https://github.com/Mon-Ouie/pry-remote>
136
-
137
132
If you want to connect via Shopify Ruby LSP VSCode extension or rdbg, start the server with `bundle exec rdbg -O -n -c -- bin/rails server -p 3000`
138
133
139
-
### Codespaces
140
-
141
-
When running tests in browser, visit the forwarded port 6080 URL to see the browser in Codespaces. You can also visit this port to access the GUI desktop in Codespaces.
142
-
143
-
In VSCode Run and Debug view, there are some helpful defaults for running RSpec tests in browser at your cursor as well as attaching to a live server. Make sure the Ruby LSP server is started before debugging.
144
-
145
134
## Squashing commits
146
135
147
136
Consider the balance of "polluting the git log with commit messages" vs. "providing useful detail about the history of changes in the git log". If you have several smaller commits that serve a one purpose, you are encouraged to squash them into a single commit. There's no hard and fast rule here about this (for now), just use your best judgement. Please don't squash other people's commits. Everyone who contributes here deserves credit for their work! :)
@@ -186,8 +175,8 @@ Before submitting a pull request, run all tests and lints. Fix any broken tests
186
175
187
176
#### Local testing
188
177
189
-
- Run all tests with `bundle exec rspec`
190
-
- You can run a single test with `bundle exec rspec {path_to_test_name}_spec.rb` or on a specific line by appending `:LineNumber`
178
+
- Run all tests with `mise spec` (or `mise docker-spec` if using docker)
179
+
- You can run a single test with `mise spec {path_to_test_name}_spec.rb` or on a specific line by appending `:LineNumber`
191
180
- If you need to skip a failing test, place `pending("Reason you are skipping the test")` into the `it` block rather than skipping with `xit`. This will allow rspec to deliver the error message without causing the test suite to fail.
0 commit comments