Skip to content

Commit

Permalink
Streamline running convene by adding docs + helper scripts
Browse files Browse the repository at this point in the history
We noticed that there was not any way to know how to get started running
the Convene::Web interface unless you happened to know how to explore
the project repository already.

By sprouting a `bin/run` script that launches the rails server, as well
as documenting how to get started in the project root readme with more
technical details in the Convene::Web README we think this will make it
easier for people to pick up the project and start contributing.

H/t @KellyAH for helping figure out where to put what documentation
updates!
  • Loading branch information
zspencer committed Aug 23, 2020
1 parent bbd54ec commit e1ba72f
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ or organizational use.

[open core model]: (https://en.wikipedia.org/wiki/Open-core_model)

## Developing Convene

Once you have installed the appropriate `ruby` and `node` and `postgresql` versions run `bin/setup`. See [Convene::Web/README.md "Configuring your Development Machine"] for more information.

[Convene::Web/README.md "Configuring your Development Machine"]:./convene-web/README.md#configuring-your-development-machine

## Using Convene

Convene is [pre-alpha software], so while we intend to provide interfaces that
Expand Down
4 changes: 4 additions & 0 deletions bin/run
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/bash

# Runs the application locally
(cd convene-web && bin/run)
3 changes: 3 additions & 0 deletions convene-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ First, ensure your development environment has:
Then, run `bin/setup` to install Ruby and Node dependencies and set up the
database.

Once you have completed setup; run `bin/run`. You now should be able to open
http://localhost:3000/workspaces/system-test and see Convene.

Finally, run `bin/test` to ensure that your development environment is
configured correctly.

Expand Down
8 changes: 8 additions & 0 deletions convene-web/bin/run
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/bash


# Conditionally assign PORT so that it can be overridden
# https://stackoverflow.com/questions/2440947/how-to-build-a-conditional-assignment-in-bash
: ${PORT:=3000}
echo $PORT
bin/rails s -p $PORT

0 comments on commit e1ba72f

Please sign in to comment.