monorepo/README.md

🏢 Maple Open Technologies Monorepo

The purpose of this repository is to store all the open-source software developed (or currently developing) for Maple Open Technologies.

🗂️ Directory Structure

This repository is organized in the following major folders:

• cloud - Contains all backend web-services related projects.
• native - Contains all projects which can be executed on specific devices.
• web - Contains all frontend related projects.

🚀 Getting Started

Want to contribute or run this locally? Here's where to begin setting up your development environment:

1. Start with the infrastructure - All backend services need this running first:

   • Go to cloud/infrastructure/README.md
   • Follow the setup instructions to get Docker containers running

2. Choose a backend to run - Pick one based on what you're working on:

   • MaplePress (WordPress cloud services): cloud/maplepress-backend/README.md
   • MapleFile (full platform): cloud/maplefile-backend/README.md

3. Optional - Run frontends or native apps:

   • Web frontend: web/maplefile-frontend/README.md
   • CLI tool: native/desktop/maplefile/README.md
   • WordPress plugin: native/wordpress/README.md

Prerequisites: Docker Desktop and Task (task runner). See the infrastructure README for installation instructions.

🤝 Contributing

Found a bug? Want a feature to improve the monorepo? Please create an issue.

📝 License

This application is licensed under the GNU Affero General Public License v3.0. See LICENSE for more information.