Skip to content

Commit

Permalink
added community files
Browse files Browse the repository at this point in the history
  • Loading branch information
norbertschuler committed Sep 29, 2024
1 parent 6a1592f commit b765278
Show file tree
Hide file tree
Showing 9 changed files with 933 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# editorconfig.org

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
13 changes: 13 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
EXPO_PUBLIC_AUTH0_DOMAIN=accounts.plant-for-the-planet.org
EXPO_PUBLIC_CLIENT_ID_AUTH0=
EXPO_PUBLIC_API_ENDPOINT=app-staging.plant-for-the-planet.org
EXPO_PUBLIC_APP_SCHEMA=org.pftp.treemapper
EXPO_PUBLIC_CDN_URL=cdn.plant-for-the-planet.org/staging
EXPO_PUBLIC_API_PROTOCOL=https
EXPO_PUBLIC_WEBAPP_URL=web.plant-for-the-planet.org
EXPO_PUBLIC_MAP_BOX_TOKEN=
EXPO_PUBLIC_OFFLINE_LINK=https://wayback.maptiles.arcgis.com/arcgis/rest/services/World_Imagery/MapServer/tile/{z}/{y}/{x}
EXPO_PUBLIC_BUGSNAG_API=
EXPO_PUBLIC_APP_ENV=staging
EXPO_WEB_APP_URL=web.plant-for-the-planet.org
EXPO_PUBLIC_EXPLORE_URL=https://web.plant-for-the-planet.org/en/profile/treemapper/data-explorer
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug Report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
projects: '1'

---

**Describe the bug**
*A clear and concise description of what the bug is.*

**Is it on a Production or Development Build?**

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
*A clear and concise description of what you expected to happen.*

**What actually happens**
*A clear and concise description of what happens instead of the expected behavior.*

**Screenshots**
*If applicable, add screenshots to help explain your problem.*

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone]
- OS: [e.g. latest iOS]
- TreeMapper App Version: [e.g. 2.0.0]

**Additional context**
*Add any other context about the problem here.*
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest a feature for TreeMapper App
title: ''
labels: enhancement
assignees: ''
---

**Describe the feature you'd like to see included in TreeMapper App.**
*A clear, detailed description of the feature you're requesting.*

**What are the use cases for this feature?**
*e.g. See list of all registrations I have uploaded etc.*

**Examples of this feature or functionality.**
*If another product has done it well, provide examples here. Or include your concept*

**Feature Checklist**

- [ ] I have searched for existing issues and to the best of my knowledge this is not a duplicate
- [ ] I have included at least one example image if it could be helpful (optional)
- [ ] The request requires change in APIs, Backend, etc (optional)
8 changes: 8 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Fixes #

Changes in this pull request:
-
-
-

@
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

When contributing to this repository, please feel free to create a pull request and describe your changes. You can also first create an issue. We will probably contact you by directly commenting on your issue or inviting you to our Slack channel to discuss your contribution.

Please note we have a [code of conduct](https://github.com/Plant-for-the-Planet-org/treemapper/blob/develop/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## Pull Request Process

1. Ensure you pull request builds.
2. Ensure that also the native apps with can be build.
3. Update the [README.md](https://github.com/Plant-for-the-Planet-org/treemapper/blob/develop/Readme.MD) if you change something in the development process.
4. You may merge the Pull Request in once you have the sign-off of another developer, or if you
do not have permission to do that, you may request the reviewer to merge it for you.

## Coding Style

Please use the configuration file at https://github.com/Plant-for-the-Planet-org/treemapper/blob/develop/.editorconfig defining the basic rules for editors to use to work on the source code. It supports a lot of different editors you can read about at https://editorconfig.org/.
54 changes: 54 additions & 0 deletions Readme.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# TreeMapper App

TreeMapper is open source application based on react-native licensed under terms of GPL v3. It is managed by [Plant-for-the-Planet Foundation](https://www.plant-for-the-planet.org/) and open source contributors.

For contributions please read our [contribution guide](https://github.com/Plant-for-the-Planet-org/treemapper/blob/develop/CONTRIBUTING.md) as well as our [code of conduct](https://github.com/Plant-for-the-Planet-org/treemapper/blob/develop/CODE_OF_CONDUCT.md) and the following information:

## TreeMapper on Web
Data uploaded by TreeMapper can be viewed on the [Plant-for-the-Planet Platform](https://pp.eco)
<img width="1289" alt="Screen Shot 2021-08-04 at 4 05 38 PM" src="https://user-images.githubusercontent.com/5401575/128246400-949f9502-0ecd-4e6b-8695-003752b05331.png">

## Directory Structure

The repository is structured by using Expo managed workflow.

## Configuration

Copy `.env.sample` file to `.env` file and add the missing tokens.

## iOS Setup

```bash
npx expo prebuild --platform ios --clean
```

### Running into iOS simulator or device

```bash
npx expo run:ios --device
```

## Android Setup

```bash
npx expo prebuild --platform android --clean
```

### Running into Android emulator or device

```bash
npx expo run:android --device
```

## Development process

This project uses GitFlow (https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) with Master-Branch `main` and Development-Branch `develop`.

## Supporters
The deployment and production of this app is also possible due to support from open-source software contributors.
<a href="https://www.browserstack.com">
<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcTPH0TU07S98aX7O5PbjVtOwLz5Q-8IAnaRWn6tv_qkxKaAedd9" height="24"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://www.bugsnag.com">
<img src="https://global-uploads.webflow.com/5c741219fd0819540590e785/5c741219fd0819856890e790_asset%2039.svg" height="24"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://lingohub.com">
<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcQqJ0vVrXzxzszvleoGhXuxpMFlGueY5UfBEP-HPtTVTH2j29hv" height="30"></a>
Loading

0 comments on commit b765278

Please sign in to comment.