Skip to content

Commit

Permalink
Add installation clarification and fix readme images
Browse files Browse the repository at this point in the history
  • Loading branch information
myieye authored and megahirt committed Sep 19, 2022
1 parent 4463497 commit 64e3ea8
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ We're glad you're here! Read our [Contributing Guide](CONTRIBUTING.md) for how

## Developers ##

Please see our [Developer Guide](docs/DEVELOPER.md) for developer best practices and environment setup
Please see our [Developer Guide](docs/DEVELOPER.md) for developer best practices and environment setup.

For production deployment and release instructions, there is a separate [Production Deployment and Release Guide](docs/RELEASE.md).
4 changes: 3 additions & 1 deletion docs/ACKNOWLEDGEMENTS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Special Thanks To ##
- ![BrowserStack Logo](readme_images/browserstack-logo.png "BrowserStack") for mobile device testing.
![BrowserStack Logo](../readme_images/browserstack-logo.png "BrowserStack")

for mobile device testing.

## Libraries Used ##

Expand Down
13 changes: 7 additions & 6 deletions docs/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ Welcome! We're glad that you are interested in helping develop Language Forge.

## Development Environment Quick Start ##

1. Install [Docker](https://www.docker.com/get-started). Linux users will need some additional steps: Please visit https://docs.docker.com/compose/install for info on installing the engine and compose. Windows users, use Ubuntu and follow these instructions -- https://docs.docker.com/engine/install/ubuntu/ -- and then, to permit specific users (and not just "sudo") to contact the Docker daemon, run `sudo usermod -aG docker $yourUsername` and `sudo chmod 666 /var/run/docker.sock`.
3. Install [Make](https://www.gnu.org/software/make/). This is actually optional but simplifies things a bit.
4. Install [Node 16.14.0](https://nodejs.org/en/download/). We recommend using a Node version manager e.g. [nvm](https://github.com/nvm-sh/nvm#installation-and-update)
5. Clone the repo: `git clone https://github.com/sillsdev/web-languageforge`
1. Install [Docker](https://www.docker.com/get-started).
1. Linux users will need some additional steps: Please visit https://docs.docker.com/compose/install for info on installing the engine and compose.
2. Windows users, use Ubuntu (WSL) and follow the instructions at https://docs.docker.com/engine/install/ubuntu/. Then permit your user (and not just "sudo") to contact the Docker daemon by running `sudo usermod -aG docker $yourUsername` and `sudo chmod 666 /var/run/docker.sock`.
3. Install [Make](https://www.gnu.org/software/make/): `sudo apt install make`. This is actually optional but simplifies things a bit.
4. Install [Node 16.14.0](https://nodejs.org/en/download/). We recommend using a Node version manager e.g. [nvm](https://github.com/nvm-sh/nvm#installation-and-update).
5. Clone the repo: `git clone -c core.symlinks=true https://github.com/sillsdev/web-languageforge`. Windows "Developer Mode" must be enabled before cloning or the symbolic links won't be created.
6. `cd web-languageforge/docker`

Expand Down Expand Up @@ -156,7 +157,7 @@ To debug the Language Forge application locally, follow these steps:
- In VS Code, set a breakpoint on a line of code that should be executed
- Click on the `Run and Debug` area of VS Code, then click the green play icon next to `XDebug` in the configuration dropdown.

![XDebug](readme_images/xdebug1.png "Debugging with XDebug")]
![XDebug](../readme_images/xdebug1.png "Debugging with XDebug")]

- The VSCode status bar will turn orange when XDebug is active
- open the application in your web browser (`https://localhost`) and use the application such that you execute the code where you have a breakpoint set
Expand All @@ -175,7 +176,7 @@ To debug the PHP tests, follow these steps:
- In VS Code, set a breakpoint on a line of code in one of the PHP tests (in the `test/php` folder)
- Click on the `Run and Debug` area of VS Code, then click the green play icon next to `XDebug` in the configuration dropdown.

![XDebug](readme_images/xdebug1.png "Debugging with XDebug")]
![XDebug](../readme_images/xdebug1.png) "Debugging with XDebug")

- The VSCode status bar will turn orange when XDebug is active
- run `make unit-tests` in the terminal
Expand Down

0 comments on commit 64e3ea8

Please sign in to comment.