Skip to content

Commit

Permalink
hyphens are so last decade
Browse files Browse the repository at this point in the history
  • Loading branch information
mjmusante committed Aug 29, 2024
1 parent 6b359eb commit af37fcc
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ We use [Docker](https://www.docker.com/) for our development environment. That l
* Go to Docker's [getting started](https://www.docker.com/get-started) page and download the Docker Desktop for your OS
* Install the Docker Desktop and start it running
* Clone the ifcomp repo into a folder on your computer
* From your shell, change to the directory `IFComp-Dev` and run `docker-compose build` which will create the docker images and install perl and the ifcomp's dependencies
* Run `docker-compose up` which will start the docker images
* From your shell, change to the directory `IFComp-Dev` and run `docker compose build` which will create the docker images and install perl and the ifcomp's dependencies
* Run `docker compose up` which will start the docker images

Note that you can also [set up a development environment by hand](https://github.com/iftechfoundation/ifcomp/wiki/Manual-Installation-and-Setup), if you don't want to use Docker for some reason.

Expand All @@ -25,11 +25,11 @@ The docker compose file starts three containers:

* `db` runs the MariaDB database

Once the containers are up and running (`docker-compose up`) the `app` container will be available on port 13000. You should be able to point your browser at http://localhost:13000/ and see the IFComp homepage.
Once the containers are up and running (`docker compose up`) the `app` container will be available on port 13000. You should be able to point your browser at http://localhost:13000/ and see the IFComp homepage.

### Executing Commands

You can execute commands directly on the app service by running `docker-compose exec app COMMAND`.
You can execute commands directly on the app service by running `docker compose exec app COMMAND`.

There are a number of convenience scripts in `IFcomp-Dev/script` as well.

Expand All @@ -51,7 +51,7 @@ There are a number of convenience scripts in `IFcomp-Dev/script` as well.

### Test Data and Files

The first time you run `docker-compose up`, a new database will be deployed, test data will be installed, and test files will be copied into place.
The first time you run `docker compose up`, a new database will be deployed, test data will be installed, and test files will be copied into place.

The database data and test files are the same data and files used by the tests in IFComp/t.

Expand Down
2 changes: 1 addition & 1 deletion IFComp-Dev/script/change_comp_phase.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

docker-compose exec app ../IFComp-Dev/script/change_comp_phase.pl $@
docker compose exec app ../IFComp-Dev/script/change_comp_phase.pl $@
4 changes: 2 additions & 2 deletions IFComp-Dev/script/load_test_data.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh

docker-compose exec app ./script/ifcomp_deploy_db.pl -d
docker-compose exec app ../IFComp-Dev/script/load_test_data.pl
docker compose exec app ./script/ifcomp_deploy_db.pl -d
docker compose exec app ../IFComp-Dev/script/load_test_data.pl
2 changes: 1 addition & 1 deletion IFComp-Dev/script/prove.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

docker-compose exec app prove $@
docker compose exec app prove $@
2 changes: 1 addition & 1 deletion IFComp-Dev/script/shell.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

docker-compose exec app bash
docker compose exec app bash
2 changes: 1 addition & 1 deletion IFComp-Dev/script/tidyall.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

docker-compose exec app tidyall -a
docker compose exec app tidyall -a
2 changes: 1 addition & 1 deletion IFComp-Dev/script/update_schema_from_database.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

docker-compose exec app ../IFComp-Dev/script/update_schema_from_database.pl
docker compose exec app ../IFComp-Dev/script/update_schema_from_database.pl

0 comments on commit af37fcc

Please sign in to comment.