38 lines
2 KiB
Markdown
38 lines
2 KiB
Markdown
# 🏢 Maple Open Technologies Monorepo
|
|
|
|
The purpose of this repository is to store all the fair and open-source software developed (or currently being developed) by Maple Open Technologies.
|
|
|
|
## 🗂️ Directory Structure
|
|
|
|
This repository is organized in the following major folders:
|
|
|
|
* [`cloud`](./cloud/README.md) - Contains all backend web-services related projects.
|
|
* [`native`](./native/README.md) - Contains all projects which can be executed on specific devices.
|
|
* [`web`](./web/README.md) - 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`](./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`](./cloud/maplepress-backend/README.md)
|
|
- **MapleFile** (full platform): [`cloud/maplefile-backend/README.md`](./cloud/maplefile-backend/README.md)
|
|
|
|
3. **Optional - Run frontends or native apps**:
|
|
- **Web frontend**: [`web/maplefile-frontend/README.md`](./web/maplefile-frontend/README.md)
|
|
- **CLI tool**: [`native/desktop/maplefile/README.md`](./native/desktop/maplefile/README.md)
|
|
- **WordPress plugin**: [`native/wordpress/README.md`](./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](https://codeberg.org/mapleopentech/monorepo/issues/new).
|
|
|
|
## 📝 License
|
|
|
|
This application is licensed under the [**Maple Open Tech License (MOTL v1.0)**](https://mapleopentech.ca/license/). See [LICENSE](LICENSE) for more information.
|