hackforla / hackforla/knowledgebase-content
Create a Guide/Template: Using Docker
- Dominant language
- No language data
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
### Overview
We need to create a guide for beginner developers to setup their environments using Docker.
### Action Items
The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.
- [ ] [Gather Examples Solo](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [ ] [Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively)
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-Your-Guide-for-Leadership-Review)
### Resources/Instructions
- Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations) [0068 [DRAFT] Using Docker ](https://drive.google.com/drive/folders/1MqABIeVhImKFdE6v7ff6gAoT3vbhso99)
#### Active without Docker documentation
311-report:
No file
#### Active with Docker documentation
- [Hack for LA's Website](https://github.com/hackforla/website)
- [config.docker.yml](https://github.com/hackforla/website/blob/gh-pages/_config.docker.yml)
- [docker-compose.yml](https://github.com/hackforla/website/blob/gh-pages/docker-compose.yml)
- [Readme.md](https://github.com/hackforla/website/blob/gh-pages/README.md) (has no docker info)
- [CONTRIBUTING.md](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md#15-dev-setup-5-set-up-docker), Docker section
- [INSTALL.md] There is no INSTALL.md file as of Jul 13 2022
- [WIKI](https://github.com/hackforla/website/wiki/Add-local-user-accounts-to-the-docker-users-group-on-Windows-10) The only instructions is this: Add local user accounts to the docker users group on Windows 10
- [Food Oasis](https://github.com/hackforla/food-oasis)
- [Dockerfile](https://github.com/hackforla/food-oasis/blob/develop/Dockerfile), most recent
- [Dockerfile-jared](https://github.com/hackforla/food-oasis/blob/develop/Dockerfile-jared), seems like an old test
- [docker-compose.yml](https://github.com/hackforla/food-oasis/blob/develop/docker-compose.yml)
- [Deployment workflows](https://github.com/hackforla/food-oasis/tree/develop/.github/workflows) build and deploy docker image to dockerhub on push to main and develop branch, then deploy the image to heroku in separate scripts
- README.md: has no docker info as of 2022-02-11
- CONTRIBUTING.md there is no contributing file as of 2022-02-11
- INSTALL.md there is no install file as of 2022-02-14
- WIKI: https://github.com/hackforla/food-oasis/wiki/Docker
- [VRMS](https://github.com/hackforla/vrms)
- Dockerfile
- backend
- [Dockerfile.api](https://github.com/hackforla/VRMS/blob/development/backend/Dockerfile.api)
- [Dockerfile.dev](https://github.com/hackforla/VRMS/blob/development/backend/Dockerfile.dev)
- [Dockerfile.prod](https://github.com/hackforla/VRMS/blob/development/backend/Dockerfile.prod)
- client
- [Dockerfile.client](https://github.com/hackforla/VRMS/blob/development/client/Dockerfile.client)
- [Dockerfile.dev](https://github.com/hackforla/VRMS/blob/development/client/Dockerfile.dev)
- [Dockerfile.prod](https://github.com/hackforla/VRMS/blob/development/client/Dockerfile.prod)
- nginx
- [Dockerfile.nginx](https://github.com/hackforla/VRMS/blob/development/nginx/Dockerfile.nginx)
- Deployment workflows
- [aws-backend-deploy.yml](https://github.com/hackforla/VRMS/blob/development/.github/workflows/aws-backend-deploy.yml)
- [aws-frontend-deploy.yml](https://github.com/hackforla/VRMS/blob/development/.github/workflows/aws-frontend-deploy.yml)
- [docker-compose.yml](https://github.com/hackforla/VRMS/blob/development/docker-compose.yml)
- README.md: does not mention docker
- CONTRIBUTING.md there is no contributing file as of 2022-02-14
- INSTALL.md there is no install file as of 2022-02-14
- [WIKI](https://github.com/hackforla/VRMS/wiki/Resources#developing-via-docker)
- [TDM Calculator](https://github.com/hackforla/tdm-calculator)
- [Dockerfile](https://github.com/hackforla/tdm-calculator/blob/develop/Dockerfile)
- [docker-compose.yml] there is no docker-compose file as of 2022-02-14
- [docker.yaml](https://github.com/hackforla/tdm-calculator/blob/develop/.github/workflows/docker.yaml) build and push docker image on push to experimental, develop, and main branches
- [README.md] does not mention docker
- [CONTRIBUTING.md] points to the wiki
- [INSTALL.md] there is no INSTALL.md file as of Jul 13 2022
- WIKI:
- [Local Database](https://github.com/hackforla/food-oasis) has instructions on settin g up a local SQL Server in docker in Window/OSX/Linux, instructions on setting up the databse, and docker tips
- [Deployment](https://github.com/hackforla/tdm-calculator/wiki/Deployment) has instructions on Azure deployment
- [HomeUniteUs](https://github.com/hackforla/homeuniteus)
- [config.docker.yml] there is no config.docker.yml file as of 2022-02-11
- [.dockerignore](https://github.com/hackforla/HomeUniteUs/blob/main/.dockerignore)
- [Dockerfile](https://github.com/hackforla/HomeUniteUs/blob/main/Dockerfile)
- [docker-compose.yml](https://github.com/hackforla/HomeUniteUs/blob/main/docker-compose.yml)
- [README.md](https://github.com/hackforla/HomeUniteUs/blob/master/scripts/README.md), is empty as of 2022-02-11
- [CONTRIBUTING.md] there is no contributing file as of 2022-02-11
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [BallotNav](https://github.com/hackforla/ballotnav)
- [config.docker.yml] has not been checked
- [docker-compose.yml] has not been checked
- [docker-compose.yml] has not been checked
- [README.md](https://github.com/hackforla/ballotnav/blob/master/backend/README.md) backend
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [100 Automations](https://github.com/100automations/website)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md](https://github.com/100Automations/Website/blob/gh-pages/CONTRIBUTING.md)
- WIKI: [URL] has not been checked
- [Engage](https://github.com/hackla-engage) (its own GitHub org)
- [engage-backend](https://github.com/hackla-engage/engage-backend)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [council-portal](https://github.com/hackla-engage/council-portal)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [engage-scraper](https://github.com/hackla-engage/engage-scraper)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [engage-scheduler](https://github.com/hackla-engage/engage-scheduler)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Engage-docker](https://github.com/hackla-engage/engage-docker)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md](https://github.com/hackla-engage/engage-docker/blob/master/README.md) has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Civic Tech Index](https://github.com/civictechindex) (its own GitHub org)
- [CTI-website-frontend](https://github.com/civictechindex/CTI-website-frontend)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md](https://github.com/civictechindex/CTI-website-frontend/blob/main/CONTRIBUTING.md#step-4-setting-up-docker) , docker section
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [CTI-website-backend](https://github.com/civictechindex/CTI-website-backend)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md](https://github.com/civictechindex/CTI-website-backend/blob/main/README.md)
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Getting-started](https://github.com/hackforla/getting-started)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- [Using-docker.md](https://github.com/hackforla/getting-started/blob/master/using-docker.md)
- WIKI: [URL] has not been checked
- [311 Data](https://github.com/hackforla/311-data
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Access the Data](https://github.com/hackforla/access-the-data)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Civic Tech Jobs](https://github.com/hackforla/CivicTechJobs)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [ ] [Data Science Projects](https://github.com/hackforla/data-science)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Design Systems](https://github.com/hackforla/design-systems)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Expunge-Assist (formerly known as Record Clearance)](https://github.com/hackforla/expunge-assist)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [GreenEarthOS](https://github.com/hackforla/climate-project)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Guides](https://github.com/hackforla/guides)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Internship project](https://github.com/hackforla/intership)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Lucky Parking](https://github.com/hackforla/lucky-parking)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Open Community Survey](https://github.com/hackforla/open-community-survey)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
- [Youth Justice Nav](https://github.com/hackforla/YouthJusticeNav/)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md] has not been checked
- WIKI: [URL] has not been checked
### Inactive Projects
#### Inactive with Docker files
- Ohana Web Search
- [ohana-api-la](https://github.com/hackforla/ohana-api-la)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md](https://github.com/hackforla/ohana-api-la/blob/master/INSTALL.md)
- WIKI: [URL] has not been checked
- [ohana-web-search-la](https://github.com/hackforla/ohana-web-search-la)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- [INSTALL.md](https://github.com/hackforla/ohana-web-search-la/blob/master/INSTALL.md)
- WIKI: [URL] has not been checked
- [Spare](https://github.com/hackforla/spare)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md](https://github.com/hackforla/spare/blob/dev/README.md)
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
- [Heart](https://github.com/hackforla/heart)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md](https://github.com/hackforla/heart/blob/develop/README.md)
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
- Notes: could not find installation file
- [RailStats LA](https://github.com/metro-ontime) aka Metro-ontime
- [performance_tracker](https://github.com/metro-ontime/performance_tracker)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md](https://github.com/metro- ontime/performance_tracker/blob/master/README.md)
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
- [railstats_api](https://github.com/metro-ontime/railstats_api)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md](https://github.com/metro-ontime/railstats_api/blob/master/README.md)
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
- [project-light-the-way](https://github.com/hackforla/project-light-the-way)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
- [citygram](https://github.com/hackforla/citygram)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
- [helloGov](https://github.com/helloGov/) (its own GitHub org)
- [webapp](https://github.com/helloGov/webapp)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md](https://github.com/helloGov/webapp/blob/master/README.md)
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
- [Shared Housing](https://github.com/hackforla/shared-housing)
- [config.docker.yml] has not been checked
- [.dockerignore] has not been checked
- [docker-compose.yml] has not been checked
- [Dockerfile] has not been checked
- [README.md] has not been checked
- [CONTRIBUTING.md] has not been checked
- WIKI: [URL] has not been checked
### Projects to Check
- [Docker Template Guide Draft](https://docs.google.com/document/d/16Mp3rsEmMFKL6K7FXFbyT3Fqgs0hIreUBU3V0mhGrPs/edit#)
- [Ops Google Drive folder for Docker Guide](https://drive.google.com/drive/u/0/folders/1rYpaQ_fjRln_7X8joDxOOI7BeGhQIB26)
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.
Contributor guide
Assessment
This issue has not been assessed yet.