Skip to content

Commit

Permalink
copy edit of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TanyaStere42 committed Nov 22, 2024
1 parent 6c54b14 commit 0d71553
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions develop-with-data/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Development
# Development

This `docker-compose.yml` file can be used to launch an instance of Scout for development purposes.
It will use the repo root directory (up one level) to run the code "live", which allows for editing and
Expand All @@ -9,16 +9,18 @@ This docker image also comes with some **example data** which can be helpful in
Also, this version of Scout **does not include scoutbot** and therefore does not require a GPU (and related setup
overhead) to function. This also means, however, that it cannot process images with ML classifiers.

## Usage
## One time setup
From root of the code directory, run `npm install` to make sure all necessary libraries are installed.

Running `docker-compose up` from this directory should be sufficient to fetch that docker image and run Scout.
There may be a few extra steps needed, depending on how your development is setup:
## Usage

- you should first run `npm install` (once) from the repo directory, to make sure all necessary libraries are installed
- when you break out of scout with ctrl-C, it is best to also do `docker-compose down` to stop the container
1. From this directory (`/develop-with-data`), run `docker-compose up` to fetch that docker image and run Scout.
1. Once running, use a browser to open http://localhost:1337. Login with `admin`/`admin` as username/password.

Once running, use a browser to open http://localhost:1337. Login with `admin`/`admin` as username/password.
## Troubleshooting
- If you encounter a docker error `urllib3.exceptions.URLSchemeUnknown: Not supported URL scheme http+docker`, try running `pip install requests=2.31.0`
- If your process fails, you should run `docker-compose down` to stop the container when you shut down your scout instance (`Ctrl+C`)

### Notes
### Credit

- Example images are from the [WAID dataset from Applied Sciences](https://github.com/xiaohuicui/WAID/).

0 comments on commit 0d71553

Please sign in to comment.