Skip to content

Commit

Permalink
Merge branch 'staging'
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Apr 3, 2024
2 parents 94de009 + c1eb545 commit 93f2825
Show file tree
Hide file tree
Showing 95 changed files with 2,014 additions and 702 deletions.
7 changes: 7 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,13 @@
"avatar_url": "https://avatars.githubusercontent.com/u/123072058?v=4",
"profile": "https://github.com/Prajwalism",
"contributions": ["code"]
},
{
"login": "manjitapandey",
"name": "Manjita Pandey",
"avatar_url": "https://avatars.githubusercontent.com/u/97273021?v=4",
"profile": "https://github.com/manjitapandey",
"contributions": ["bug"]
}
],
"contributorsPerLine": 7,
Expand Down
24 changes: 13 additions & 11 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,14 @@

- [ ] 🍕 Feature
- [ ] 🐛 Bug Fix
- [ ] 📝 Documentation Update
- [ ] 🎨 Style
- [ ] 🧑‍💻 Code Refactor
- [ ] 🔥 Performance Improvements
- [ ] 📝 Documentation
- [ ] 🧑‍💻 Refactor
- [ ] ✅ Test
- [ ] 🤖 Build
- [ ] 🔁 CI
- [ ] 📦 Chore (Release)
- [ ] ⏩ Revert
- [ ] 🤖 Build or CI
- [ ] ❓ Other (please specify)

## Related Issue

Ticket number, link, or description.

Example: Fixes #123

## Describe this PR
Expand All @@ -26,10 +20,18 @@ A brief description of how this solves the issue.

Please provide screenshots of the change.

## Alternative Approaches Considered

Did you attempt any other approaches that are not documented in code?

## Review Guide

Notes for the reviewer. How to test this change?

## Checklist before requesting a review

- 📖 Read the FMTM Contributing Guide: <https://github.com/hotosm/fmtm/blob/main/CONTRIBUTING.md>
- 📖 Read the FMTM Code of Conduct: <https://github.com/hotosm/fmtm/blob/main/CODE_OF_CONDUCT.md>
- 📖 Read the HOT Code of Conduct: <https://docs.hotosm.org/code-of-conduct>
- 👷‍♀️ Create small PRs. In most cases, this will be possible.
- ✅ Provide tests for your changes.
- 📝 Use descriptive commit messages.
Expand Down
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ On a Linux-based machine with `bash` installed, run the script:
> However, if you run as root, a user svcfmtm will be created for you.
```bash
curl -L https://https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
curl -L https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
bash install.sh

# Then follow the prompts
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ and [contributor guidance](https://hotosm.github.io/fmtm/CONTRIBUTING/)
for more details!
Reach out to us if any questions! 👍🎉

## Using OpenDataKit's Select From Map feature
## Using ODK's Select From Map feature

As of mid-2022, ODK incorporates a new functionality, select from map,
that allows field mappers to select an object from a map,
Expand Down Expand Up @@ -110,7 +110,7 @@ field mappers to go out and collect data. They need to:
### Field mappers

Field mappers select (or are allocated) individual tasks within a project
AOI and use ODK Collect to gather data in those areas. They need to:
AOI and use the ODK mobile app to gather data in those areas. They need to:

- Visit a mobile-friendly Web page where they can see available tasks on a map
- Choose an area and launch ODK Collect
Expand Down Expand Up @@ -138,7 +138,7 @@ To install for a quick test, or on a production instance,
use the convenience script:

```bash
curl -L https://https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
curl -L https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
bash install.sh
```

Expand All @@ -149,7 +149,7 @@ A breakdown of the components:
### ODK Collect

A mobile data collection tool that functions on almost all Android phones.
Field mappers use ODK Collect to select features such as buildings or amenities,
Field mappers use the ODK mobile app to select features such as buildings or amenities,
and fill out forms with survey questions to collect attributes or data
about those features (normally at least some of these attributes are intended
to become OSM tags associated with those features).
Expand Down Expand Up @@ -303,6 +303,7 @@ Thanks goes to these wonderful people:
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Roseford"><img src="https://avatars.githubusercontent.com/u/75838716?v=4?s=100" width="100px;" alt="Uju"/><br /><sub><b>Uju</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Roseford" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.el-cordovez.com"><img src="https://avatars.githubusercontent.com/u/75356640?v=4?s=100" width="100px;" alt="JC CorMan"/><br /><sub><b>JC CorMan</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=cordovez" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Prajwalism"><img src="https://avatars.githubusercontent.com/u/123072058?v=4?s=100" width="100px;" alt="Prajwal Khadgi"/><br /><sub><b>Prajwal Khadgi</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/commits?author=Prajwalism" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/manjitapandey"><img src="https://avatars.githubusercontent.com/u/97273021?v=4?s=100" width="100px;" alt="Manjita Pandey"/><br /><sub><b>Manjita Pandey</b></sub></a><br /><a href="https://github.com/hotosm/fmtm/issues?q=author%3Amanjitapandey" title="Bug reports">🐛</a></td>
</tr>
</tbody>
<tfoot>
Expand Down
9 changes: 9 additions & 0 deletions docker-compose.development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,15 @@ services:
- fmtm-net
restart: "unless-stopped"

pyxform:
image: "ghcr.io/getodk/pyxform-http:v2.0.2"
depends_on:
central-db:
condition: service_healthy
networks:
- fmtm-net
restart: "unless-stopped"

central-ui:
# This service simply builds the frontend to a volume
# accessible to the proxy, then shuts down
Expand Down
1 change: 1 addition & 0 deletions docker-compose.main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ services:
args:
APP_VERSION: main
VITE_API_URL: https://${FMTM_API_DOMAIN:-api.${FMTM_DOMAIN}}
NODE_ENV: production
volumes:
- fmtm_frontend:/frontend
network_mode: none
Expand Down
9 changes: 9 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,15 @@ services:
- fmtm-net
restart: "unless-stopped"

pyxform:
image: "ghcr.io/getodk/pyxform-http:v2.0.2"
depends_on:
central-db:
condition: service_healthy
networks:
- fmtm-net
restart: "unless-stopped"

central-ui:
# This service simply builds the frontend to a volume
# accessible to the proxy, then shuts down
Expand Down
6 changes: 3 additions & 3 deletions docs/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ you're interested in getting involved, please see our
for more information. We welcome questions and feedback, so don't hesitate
to reach out to us. 👍🎉

## Using OpenDataKit's Select From Map feature
## Using ODK's Select From Map feature

OpenDataKit's Select From Map feature is a useful tool for field mappers to
ODK's Select From Map feature is a useful tool for field mappers to
collect data in a well-structured questionnaire format. The tool was
incorporated into ODK in mid-2022 and allows mappers to select an object from a
map, view its existing attributes, and fill out a form with new information
Expand Down Expand Up @@ -116,7 +116,7 @@ to go out and collect data. They need to:
### Field mappers

Field mappers select (or are allocated) individual tasks within a project AOI
and use ODK Collect to gather data in those areas. They need to:
and use the ODK mobile app to gather data in those areas. They need to:

- Visit a mobile-friendly Web page where they can see available tasks on a map
- Choose an area and launch ODK Collect with the form corresponding to their
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF = "Organize field mapping with OpenDataKit and OpenStreetMap"
PROJECT_BRIEF = "Organize field mapping with ODK and OpenStreetMap"

# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
Expand Down
2 changes: 1 addition & 1 deletion docs/Guide-On-Improving-Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ added to and built upon.

1. **Acronyms should be stated in full before repetitive
use**. Acronyms like ODK, OSM, etc, should be stated in full before
use or after each use within brackets e.g ODK (Open Data Kit). This
use or after each use within brackets e.g ODK (ODK). This
negates confusion for readers / users and just simplifies things.

2. **Important features should be put in bold**. For example “select
Expand Down
4 changes: 2 additions & 2 deletions docs/User-Manual-For-Project-Managers.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ their progress. The tool includes features for collaborative editing,
data validation, and error detection. This ensures that the data
collected by volunteers is accurate and reliable.

**FMTM** is designed to be used in conjunction with **Open Data Kit
**FMTM** is designed to be used in conjunction with **ODK
(ODK)**. **ODK** is a free and open-source set of tools that allows
users to create, collect, and manage data with mobile devices. The
**ODK** provides a set of open-source tools that allow users to build
Expand Down Expand Up @@ -133,7 +133,7 @@ and improve the effectiveness of humanitarian efforts.

10. If your organization's name is not listed, you can add it through the
"Manage Organization" tab.
11. Provide the necessary credentials for the ODK (Open Data Kit) central setup,
11. Provide the necessary credentials for the ODK (ODK) central setup,
including URL, username, and password.
12. Proceed to the next step, which is uploading the area for field mapping.
Choose the file option and select the AOI (Area of Interest) file in GEOJSON
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/Production.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ your own cloud server.
### Run the install script

```bash
curl -L https://https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
curl -L https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
bash install.sh

# Then follow the prompts
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ A computer-screen-optimized web app that allows Campaign Managers to:
#### [ODK Collect](https://docs.getodk.org/collect-intro/)

A mobile data collection tool that functions on almost all Android phones.
Field mappers use ODK Collect to select features such as buildings or amenities,
Field mappers use the ODK mobile app to select features such as buildings or amenities,
and fill out forms with survey questions to collect attributes or data about
those features (normally at least some of these attributes are intended to
become OSM tags associated with those features).
Expand Down
4 changes: 4 additions & 0 deletions src/backend/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
ARG PYTHON_IMG_TAG=3.10
ARG MINIO_TAG=${MINIO_TAG:-RELEASE.2024-01-01T16-36-33Z}
FROM docker.io/minio/minio:${MINIO_TAG} as minio
FROM docker.io/protomaps/go-pmtiles:v1.19.0 as go-pmtiles


# Includes all labels and timezone info to extend from
Expand Down Expand Up @@ -107,6 +108,9 @@ RUN set -ex \
&& rm -rf /var/lib/apt/lists/*
# Copy minio mc client
COPY --from=minio /usr/bin/mc /usr/local/bin/
# Copy go-pmtiles until for mbtiles-->pmtiles conversion
# FIXME osm-fieldwork should do this, but is currently broken
COPY --from=go-pmtiles /go-pmtiles /usr/local/bin/pmtiles
COPY *-entrypoint.sh /
ENTRYPOINT ["/app-entrypoint.sh"]
# Copy Python deps from build to runtime
Expand Down
Loading

0 comments on commit 93f2825

Please sign in to comment.