https://github.com/caltech-ipac/firefly-help

Firefly documentation
https://github.com/caltech-ipac/firefly-help

documentation ipac-firefly

Last synced: about 1 month ago
JSON representation

Firefly documentation

• Host: GitHub
• URL: https://github.com/caltech-ipac/firefly-help
• Owner: Caltech-IPAC
• Created: 2020-06-02T22:05:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T17:43:16.000Z (5 months ago)
• Last Synced: 2024-08-12T20:42:19.760Z (5 months ago)
• Topics: documentation, ipac-firefly
• Language: HTML
• Homepage:
• Size: 41.3 MB
• Stars: 1
• Watchers: 11
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README-docker.md

Awesome Lists containing this project

README

        
## Using Docker development environment

This is an alternative to setting up local dependencies.  Using Docker, the only dependency is Docker itself.  

Follow instructions [here](https://docs.docker.com/get-docker/) to install Docker Desktop.

#### Mac user

Install instructions is here: https://docs.docker.com/docker-for-mac/install/

On macOS, only shared paths are accessible by Docker.  

Your source files need to be included in shared paths.  

You can configure shared paths from `Docker -> Preferences... -> Resources -> File Sharing.`  

See https://docs.docker.com/docker-for-mac/osxfs/#namespaces for more info.  

Unlike Docker on Linux, any file system changes need to be passed between the host and container via Docker for Mac, which 

can soon add a lot of additional computational overhead.  

For this reason, you will see slightly slower performance when running on MacOS

## Quick Start

    git clone https://github.com/Caltech-IPAC/firefly-help

    cd firefly-help

    docker compose up [--build]

The above commands will create firefly-help repository with the latest changes then 

build and run it locally on port 3000.  To test, point browser to http://localhost:3000/

By default, docker-compose will build the image if one does not exists.  Once image is built, it will use

the existing image and will not attempt to build again.  Use **--build** to force a build before starting 

the container.  This is needed when you're made changes to the source and wanted to rebuild before starting.