Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated the 'Fast local changes' section in README.md [Developer guide enhancement] #315

Merged
merged 2 commits into from
Apr 4, 2020
Merged

Updated the 'Fast local changes' section in README.md [Developer guide enhancement] #315

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f6025c
Updated the README.md to include the instructions for setting up caMi…
cjchirag7 Apr 4, 2020
5941f2c
Merge branch 'develop' of https://github.com/camicroscope/caMicroscop…
cjchirag7 Apr 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 32 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,38 @@ caMicroscope is open source software. Any involvement and contribution with the
It is highly recommended to make any changes off of the develop branch of a repository, and, when ready, create a PR to the develop branch of the source repository. Before sending the PR, make sure that there are no linting errors by running ```npm install``` and then ```npm run lint``` in the repository folder.

## Fast Local Changes
When using the [hosted setup](https://github.com/camicroscope/Distro/), you can have the distribution host the changes from your local. Clone this repository and the distribution in the same parent directory, in this repo, `mv .nocache.htaccess .htaccess` then replace the viewer section of develop.yml with something like this:
When using the hosted setup, you can have the distribution host the changes from your local. Follow these steps :
- Clone this repository, the [Caracal repository](https://github.com/camicroscope/Caracal/) and [the distribution](https://github.com/camicroscope/Distro/) in the same parent directory
- In this repo, `mv .nocache.htaccess .htaccess`
- Replace the 'back' section of develop.yml in Distro repository with something like this:
```
viewer:
build: "https://github.com/caMicroscope/caMicroscope.git#develop"
container_name: ca-front
environment:
- cacheoff=true
back:
build:
context: "../Caracal"
args:
viewer: "develop"
depends_on:
- "mongo"
ports:
- "4010:4010"
container_name: ca-back
volumes:
- ../caMicroscope/:/usr/local/apache2/htdocs/
- ./config/login.html:/root/src/static/login.html
- ./jwt_keys/:/root/src/keys/
- ../caMicroscope:/root/src/camicroscope
environment:
JWK_URL: "https://www.googleapis.com/oauth2/v3/certs"
IIP_PATH: "http://ca-iip/fcgi-bin/iipsrv.fcgi"
MONGO_URI: "mongodb://ca-mongo"
DISABLE_SEC: "true"
ALLOW_PUBLIC: "true"
```
- Remove this line from 'Dockerfile' in Caracal repository :
```
RUN if [ -z ${viewer} ]; then git clone https://github.com/camicroscope/camicroscope.git; else git clone https://github.com/camicroscope/camicroscope.git --branch=$viewer; fi
```
- In Distro repository, enter the following commands :
```
docker-compose -f develop.yml build
cjchirag7 marked this conversation as resolved.
Show resolved Hide resolved
docker-compose -f develop.yml up
```