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
npm install --legacy-peer-deps
npm run dev
# or
yarn devOpen 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
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 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.