https://github.com/Plant-for-the-Planet-org/planet-webapp

The Open Source and Commission Free Application that powers the Trillion Tree Campaign. Visit us to meet reforestation Organizations, individuals and companies who are on a journey to plant, monitor and restore a trillion trees.
https://github.com/Plant-for-the-Planet-org/planet-webapp

climate-change nextjs plant reforestation trillion-trees

Last synced: 2 months ago
JSON representation

The Open Source and Commission Free Application that powers the Trillion Tree Campaign. Visit us to meet reforestation Organizations, individuals and companies who are on a journey to plant, monitor and restore a trillion trees.

• Host: GitHub
• URL: https://github.com/Plant-for-the-Planet-org/planet-webapp
• Owner: Plant-for-the-Planet-org
• License: other
• Created: 2020-06-11T15:45:29.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2024-10-29T09:58:35.000Z (3 months ago)
• Last Synced: 2024-10-29T11:46:00.983Z (3 months ago)
• Topics: climate-change, nextjs, plant, reforestation, trillion-trees
• Language: TypeScript
• Homepage: https://www.trilliontreecampaign.org
• Size: 183 MB
• Stars: 36
• Watchers: 11
• Forks: 15
• Open Issues: 73
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: license.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• open-sustainable-technology - Plant-for-the-Planet - Allows you to plant trees with over 100 reforestation projects around the world. (Biosphere / Deforestation and Reforestation)

README

        



















    





    





    



















[![CodeFactor](https://www.codefactor.io/repository/github/plant-for-the-planet-org/planet-webapp/badge)](https://www.codefactor.io/repository/github/plant-for-the-planet-org/planet-webapp)

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/Plant-for-the-Planet-org/planet-webapp/tree/main)

---

## Directory Structure

pages - All the routes



    
_app = Page initializations of the project

    
_document = A custom Document is commonly used to augment your application's html and body tags.

    
404 = Default 404 page if the route is not found

    
 Project pages -

    

    

        

            #

            Page Name

            Route

            Functionality

        

        

         1

            index.tsx

            /

            Home page of the app with all the projects in list and map

        

        

         2

            [id].tsx

            /project-id

            Page of single project which loads all the details of the same

        

        

         3

            about.tsx

            /about

            About the organization

        

        

         4

            leaderboard.tsx

            /leaderboard

            Showcases the top donors from around the world

        

        

         5

            me.tsx

            /me

            User's private profile

        

        

         6

            t/[id].tsx

            /t/tpo-id

            TPO's profile

        

    



public - Assets



    
tenants = Assets of all the tenants

    
assets = All the images and image components 

    
And other public assets.




src - Source code



    
features = Project features are present here 

    
tenants = Tenant specific features are present here

    
theme = Theme scss files 

    
utils = Utility functions



---

## Configuration

### Environment Setup

Rename `env.local.sample` to `env.local` and add the necessary keys

---

## Development

### Run the development server

```bash

npm install --legacy-peer-deps

npm run dev

# or

yarn dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. The page auto-updates as you edit the file.

---

## Development Process

This project uses GitFlow (https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) with Master-Branch `master` and Development-Branch `develop`. The Master-Branch will be automatically released by Vercel bot to the production system. There are currently some more protected branches also build by Vercel bot automatically and mapped to test backends using the branch name as subdomain.

---

## Reporting a Vulnerability

If you have found a vulnerability, you could write us at: [email protected] with details or create a PR for the fix.

## Important Links

[Demo Deployment](https://dev.pp.eco/)

[Designs & Prototype](https://xd.adobe.com/view/8f1c5110-4d7d-445d-8283-8eb1674ce2e4-da4f/)

[Backend APIs](https://plant-for-the-planet.stoplight.io/docs/treecounter-platform/)

## Thank You

The deployment and management of this application is possible with support from open source contributors and following partners.



      

## Legal

Any brand-images/logo/iconography used in this project, including of Plant-for-the-Planet, are registered trademark(s) of respective parties.

[Trillion Tree Campaign icon](https://www.trilliontreecampaign.org/tenants/ttc/logo.png) is available under Creative Commons CC BY-NC-ND.

Please contact partner[at]plant-for-the-planet[dot]org for approval to use the Plant-for-the-Planet Logo.