/key-conservation-mobile

This is the React Native portion of the the Key Conservation Key app.

Primary LanguageJavaScriptMIT LicenseMIT

Key Conservation

Current version: 5.2.0. This app is in Beta for iOS and Android.

Key Conservation PVD

Trello Board

Git Flow

MIT code style: prettier Maintainability Test Coverage

Contributors

Labs 24 - Sixth Product Cycle

Team Lead:

Richard Machado - GitHub | LinkedIn

React Native Developers:

Michael Callahan - GitHub | LinkedIn

Afia Caruso - GitHub | LinkedIn

Alston Garrett - GitHub | LinkedIn

Zahid Khawaja - GitHub | LinkedIn

Daniel Kyman - GitHub | LinkedIn https://www.linkedin.com/in/daniel-kyman-6816b3b2/)

Previous Labs Teams Who Contributed To This Project

Labs 22 - Fifth Product Cycle

Team Lead:

Katie Rose Felten - GitHub | LinkedIn

React Native Developers:

Kelly Moreira - GitHub | LinkedIn

Jess Novak - GitHub | LinkedIn

Alex Gohorel - GitHub | LinkedIn

Robert Stepanov - GitHub | LinkedIn

Labs 20 - Fourth Product Cycle

Team Lead:

Katie Rose Felten - GitHub | LinkedIn

Android Developer:

Albert Yakubov - GitHub | LinkedIn

React Native Developers:

Mohammad Tourjoman - GitHub | LinkedIn

Jasmine Kasheboon Khoury - GitHub | LinkedIn

Brianna Workman - GitHub | LinkedIn

Arielle Hollingsworth- Github | LinkedIn

Rasha Moumneh - Github | LinkedIn

Labs 18 - Third Product Cycle

Team Lead:

Katie Rose Felten - GitHub | LinkedIn

UX:

Nilpa Jhaveri - LinkedIn

Dylan Stephenson - LinkedIn

React Native Developers:

Cameron Alvarado - GitHub | LinkedIn

Julie Gumerman - GitHub | LinkedIn

Jonathan Solari - GitHub | LinkedIn

Yi Lun Weng - Github | LinkedIn

Blake Goms - Github | LinkedIn

Iris Jitomo - Github | LinkedIn


Labs 16 - Second Product Cycle

Team Lead:

Cori Paris - GitHub | LinkedIn

UX:

Daniel Stadler - LinkedIn

Colton Mortensen - LinkedIn

React Native Developers:

Mary Sabol - GitHub | LinkedIn

Jamie Goodnight - GitHub | LinkedIn

Katie Felten - GitHub | LinkedIn

Cesar Aponte - GitHub | LinkedIn

Samantha Egge - GitHub | LinkedIn

Brandon Harrison - GitHub | LinkedIn

Labs 14 - First Product Cycle

Team Lead:

Asa-Michael Shalom - GitHub | LinkedIn

UX:

Luis Morabito - LinkedIn

Gabby Loscalzo - LinkedIn

React Native Developers:

Cori Paris - GitHub | LinkedIn

Jay Maas - GitHub | LinkedIn

Leonel Flores - GitHub | LinkedIn

Bazen Berhane - GitHub | LinkedIn

Matthew Klein - GitHub | LinkedIn

Taslim Yakub - GitHub | LinkedIn

Zach Christy - GitHub | LinkedIn

Sam Jeffcoat - GitHub | LinkedIn

Project Description

Key Conservation is helping conservationists gain critical funding and global support through a mobile app that provides real-time updates on day-to-day campaigns.

We are wildlife biologists who saw a massive disconnect in the way we could reach out for real-time global support for critical needs outside our project's budget. We also knew conservation organizations all over the world were facing similar issues.

Additionally, supporters of conservation organizations want more transparency as to where their money is going, what the outcome of their support is, as well as, better ways to stay connected.

Key Features

  • Authentication with Auth0.
  • Airtable API integration for organization onboarding.
  • Conservation profiles to create campaigns.
  • Create/Update/Delete campaigns.
  • Supporter profiles to donate to campaigns.
  • Search campaigns.
  • All users can edit/personalize profile.
  • Commenting on campaigns.
  • Video uploading.
  • Urgency levels for campaign posts.
  • Map to view location of conservationists.

Tech Stack

Front end built using:

  • Preferred Choice of Stakeholder
  • Expo is able to produce code base for iOS and Android
  • Relatable to current React experience for Development Team
  • Expo is widely supported and used by many companies

Front End Published to Expo

Back End built using:

NodeJs/Express/PostgreSQL

  • Express server for resftul API.
  • Familiarity and experience in creating production ready code.
  • Ease of integration to Expo.
  • PGAdmin to quickly edit/view database.

APIs

Auth0

Auth0 provides authentication and authorization as a service and includes a whole suite of products available to benefit owner/user/developer.

Amplitude Analytics

Amplitude provides analytics for our app in a way that is easiest to work with Expo without having to eject.

We have setup a HOC to wrap desired components to have analytics. The component is called withAmplitude.js. There are functions in there as well that can be imported for easier and quicker use.

Airtable API

Airtable allows for stakeholder to review and grant access to new organizations signing up for the app.

Staging API here

(https://key-conservation-staging.herokuapp.com)

Production API here

(https://key-conservation.herokuapp.com)

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

Content Licenses

Source / Creator License
Font Awesome Pro License

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See PVD - Technical Research for details on overall architecture.