admin/PolyMPR
1
0
Fork 0
Code Issues 14 Pull Requests 1 Actions Packages Projects 1 Releases Wiki Activity

Deno police

Kevin FEDYNA
2025-01-28 23:43:58 +01:00
parent c30eb6773c
commit 20b5d97a49
9 changed files with 282 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLI.md
+29 -10
@@ -1,10 +1,13 @@
# CLI Documentation 📄
The **PolyMPR CLI** is a powerful command-line tool designed to simplify the development of PolyMPR. This page provides an overview of the CLI commands and their usage. 🛠️
The **PolyMPR CLI** is a powerful command-line tool designed to simplify the
development of PolyMPR. This page provides an overview of the CLI commands and
their usage. 🛠️
## Installation ⚙️
To use the PolyMPR CLI, ensure you have **Deno** installed. If not, follow the [Deno installation guide](https://deno.land/#installation).
To use the PolyMPR CLI, ensure you have **Deno** installed. If not, follow the
[Deno installation guide](https://deno.land/#installation).
Once Deno is installed, you can install the PolyMPR CLI globally by running:
@@ -25,45 +28,61 @@ pmpr help
#### `pmpr help`
**Syntax**
```bash
pmpr help
```
Get all available commands, run by default when `pmpr` is runned without any command.
Get all available commands, run by default when `pmpr` is runned without any
command.
### Module commands 🧩
#### `pmpr module list`
**Syntax**
```bash
pmpr module list
```
List all modules. Pipe this command through `grep` to check if a module is defined.
List all modules. Pipe this command through `grep` to check if a module is
defined.
#### `pmpr module create`
**Syntax**
```bash
pmpr module create <module-name-kebab-case>
```
Create a new module with the name given as argument. Please refer to the [modules page](./modules) for further information about module creation.
Create a new module with the name given as argument. Please refer to the
[modules page](./modules) for further information about module creation.
## Troubleshooting 🛠️
If you encounter issues while using the CLI, try the following:
1. **Check the Logs**: Look for error messages in the terminal output.
2. **Update the CLI**: Ensure you’re using the latest version of the PolyMPR CLI.
2. **Update the CLI**: Ensure you’re using the latest version of the PolyMPR
CLI.
```bash
deno task compile
```
3. **Consult the Documentation**: Refer to the [CLI documentation](/cli) for detailed usage instructions.
4. **Ask the Community**: Reach out to the [GitHub Discussions](https://github.com/fedyna-k/PolyMPR/discussions) for help.
3. **Consult the Documentation**: Refer to the [CLI documentation](/cli) for
detailed usage instructions.
4. **Ask the Community**: Reach out to the
[GitHub Discussions](https://github.com/fedyna-k/PolyMPR/discussions) for
help.
## Next Steps 🚀
Now that you’re familiar with the PolyMPR CLI, here are some resources to help you get started:
Now that you’re familiar with the PolyMPR CLI, here are some resources to help
you get started:
- **[Tutorials](./tutorials)**: Step-by-step guides for common tasks.
- **[FAQs](./faqs)**: Find answers to common questions.
Thank you for using the PolyMPR CLI! If you have any questions or need further assistance, feel free to reach out to the community. Happy coding! 💻✨
Thank you for using the PolyMPR CLI! If you have any questions or need further
assistance, feel free to reach out to the community. Happy coding! 💻✨
Contributing.md
+53 -19
@@ -1,6 +1,10 @@
# Contributing to PolyMPR 🤝
Thank you for your interest in contributing to **PolyMPR**! Whether you're a developer, designer, or just someone with great ideas, your contributions are welcome and appreciated. This guide will walk you through the process of contributing to the project, from setting up your environment to submitting your changes. 🚀
Thank you for your interest in contributing to **PolyMPR**! Whether you're a
developer, designer, or just someone with great ideas, your contributions are
welcome and appreciated. This guide will walk you through the process of
contributing to the project, from setting up your environment to submitting your
changes. 🚀
## How to Contribute 🛠️
@@ -15,59 +19,75 @@ There are many ways to contribute to PolyMPR, including:
## Getting Started 🚀
### 1. **Set Up Your Development Environment**
Before you start contributing, you'll need to set up your development environment. Follow these steps:
Before you start contributing, you'll need to set up your development
environment. Follow these steps:
1². **Clone the Repository**:
- Clone your forked repository to your local machine:
```bash
git clone https://github.com/fedyna-k/PolyMPR.git
cd PolyMPR
```
- Clone your forked repository to your local machine:
```bash
git clone https://github.com/fedyna-k/PolyMPR.git
cd PolyMPR
```
3. **Install Dependencies**:
- Ensure you have **Deno** installed. If not, follow the [Deno installation guide](https://deno.land/#installation).
- Ensure you have **Deno** installed. If not, follow the
[Deno installation guide](https://deno.land/#installation).
- Install project dependencies:
```bash
deno task start
```
4. **Set Up Docker (Optional)**:
- If you plan to use Docker, ensure it’s installed and running. Use the provided `docker-compose.yml` file to build and run the application:
- If you plan to use Docker, ensure it’s installed and running. Use the
provided `docker-compose.yml` file to build and run the application:
```bash
docker compose up --build
```
### 2. **Find an Issue or Suggest a New Feature**
- Browse the [Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues) to find open issues or feature requests.
- If you have a new idea, open a new issue to discuss it with the community before starting work.
- Browse the [Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues) to find
open issues or feature requests.
- If you have a new idea, open a new issue to discuss it with the community
before starting work.
### 3. **Create a New Branch**
Before making changes, create a new branch for your work:
```bash
git checkout -b PMPR-:ISSUE_ID:
```
### 4. **Make Your Changes**
- Write your code, fix bugs, or improve documentation.
- Follow the [coding guidelines](#coding-guidelines) to ensure consistency.
### 5. **Test Your Changes**
- Run the application locally to ensure your changes work as expected.
- Ensure all tests pass.
### 6. **Commit Your Changes**
- Commit your changes with a clear and descriptive commit message:
```bash
git commit -m "Add: New feature for user management"
```
### 7. **Push Your Changes**
Push your changes to your forked repository:
```bash
git push origin feature/your-feature-name
```
### 8. **Submit a Pull Request (PR)**
1. Go to the [PolyMPR GitHub repository](https://github.com/fedyna-k/PolyMPR).
2. Click the "New Pull Request" button.
3. Select your branch and provide a detailed description of your changes.
@@ -78,18 +98,23 @@ git push origin feature/your-feature-name
To maintain consistency across the project, please follow these guidelines:
### 1. **Code Style**
- Use **TypeScript** for all new code.
- Follow the Deno style guide for formatting.
- Use meaningful variable and function names.
### 2. **Documentation**
- Update the documentation if your changes introduce new features or modify existing ones.
- Update the documentation if your changes introduce new features or modify
existing ones.
- Use clear and concise comments in your code.
### 3. **Testing**
- Ensure all tests pass before submitting a PR.
### 4. **Commit Messages**
- Use the following format for commit messages:
```
Type: Short description
@@ -99,7 +124,8 @@ To maintain consistency across the project, please follow these guidelines:
## Community Guidelines 🌟
We value a positive and inclusive community. Please follow these guidelines when contributing:
We value a positive and inclusive community. Please follow these guidelines when
contributing:
1. **Be Respectful**: Treat everyone with kindness and respect.
2. **Be Open-Minded**: Welcome diverse perspectives and ideas.
@@ -108,22 +134,30 @@ We value a positive and inclusive community. Please follow these guidelines when
## Recognition and Thanks 🙏
We appreciate every contribution, no matter how small! Contributors will be recognized in the following ways:
We appreciate every contribution, no matter how small! Contributors will be
recognized in the following ways:
- Your name will be added to the [Contributors List](#contributors-list).
- You’ll receive a shoutout in the release notes for significant contributions.
## Contributors List 🌟
Thank you to all the amazing contributors who have helped make PolyMPR better! 🎉
Thank you to all the amazing contributors who have helped make PolyMPR better!
🎉
- **Kevin FEDYNA** - Project initiator and architect.
- **Romain MUNOS** - Project initiator and main developer.
## Next Steps 🚀
Now that you know how to contribute, here are some resources to help you get started:
- **[Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues)**: Find open issues to work on.
- **[Documentation](https://github.com/fedyna-k/PolyMPR/wiki)**: Learn more about PolyMPR’s architecture and features.
Now that you know how to contribute, here are some resources to help you get
started:
- **[Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues)**: Find open
issues to work on.
- **[Documentation](https://github.com/fedyna-k/PolyMPR/wiki)**: Learn more
about PolyMPR’s architecture and features.
- **[Tutorials](/tutorials)**: Step-by-step guides for common tasks.
Thank you for contributing to PolyMPR! Together, we can build a better future for HR management. Happy coding! 💻✨
Thank you for contributing to PolyMPR! Together, we can build a better future
for HR management. Happy coding! 💻✨
FAQs.md
+83 -27
@@ -1,28 +1,45 @@
# FAQs ❓
Welcome to the **Frequently Asked Questions (FAQs)** page for PolyMPR! Here, you'll find answers to common questions about the platform, its features, and how to use it effectively. If you don't find what you're looking for, feel free to reach out to the community or consult the [documentation](https://github.com/fedyna-k/PolyMPR/wiki). 🛠️
Welcome to the **Frequently Asked Questions (FAQs)** page for PolyMPR! Here,
you'll find answers to common questions about the platform, its features, and
how to use it effectively. If you don't find what you're looking for, feel free
to reach out to the community or consult the
[documentation](https://github.com/fedyna-k/PolyMPR/wiki). 🛠️
## General Questions 🌐
### 1. **What is PolyMPR?**
PolyMPR (Poly Management Platform for Resources) is a **Deno/Fresh-based framework** designed to help the INFO department transition to cloud-based HR management. It uses a **modulith architecture** to ensure flexibility, scalability, and ease of maintenance.
PolyMPR (Poly Management Platform for Resources) is a **Deno/Fresh-based
framework** designed to help the INFO department transition to cloud-based HR
management. It uses a **modulith architecture** to ensure flexibility,
scalability, and ease of maintenance.
### 2. **Who is PolyMPR for?**
PolyMPR is tailored for the **Polytech departments**, more specifically INFO department, looking to modernize their HR systems and transition to the cloud.
PolyMPR is tailored for the **Polytech departments**, more specifically INFO
department, looking to modernize their HR systems and transition to the cloud.
### 3. **What are the key features of PolyMPR?**
PolyMPR offers:
- **Modulith architecture** for easy customization and scalability.
- **Cloud-native design** for seamless integration with cloud services.
- **Deno and Fresh framework** for secure, fast, and modern web applications.
### 4. **Is PolyMPR open-source?**
Yes! PolyMPR is **open-source** and released under the **MIT License**. You can view, modify, and distribute the code as per the license terms.
Yes! PolyMPR is **open-source** and released under the **MIT License**. You can
view, modify, and distribute the code as per the license terms.
## Installation and Setup 🛠️
### 5. **How do I install PolyMPR?**
To install PolyMPR, clone the GitHub repository and follow the [installation guide](./installation). You’ll need **Deno** and optionally **Docker** for containerized deployments.
To install PolyMPR, clone the GitHub repository and follow the
[installation guide](./installation). You’ll need **Deno** and optionally
**Docker** for containerized deployments.
```bash
git clone https://github.com/fedyna-k/PolyMPR.git
@@ -31,10 +48,15 @@ deno task start
```
### 6. **Do I need to install Deno separately?**
No, Deno is not required to run PolyMPR if you run it with Docker compose. But you can install it using the official [Deno installation guide](https://deno.land/#installation).
No, Deno is not required to run PolyMPR if you run it with Docker compose. But
you can install it using the official
[Deno installation guide](https://deno.land/#installation).
### 7. **Can I use Docker with PolyMPR?**
Absolutely! Docker is optional but recommended for containerized deployments. Use the provided `compose.yml` file to build and run the application.
Absolutely! Docker is optional but recommended for containerized deployments.
Use the provided `compose.yml` file to build and run the application.
```bash
docker compose up --build
@@ -43,58 +65,92 @@ docker compose up --build
## Modules and Customization 🧩
### 8. **What are modules in PolyMPR?**
Modules are self-contained units of functionality that can be added, removed, or updated independently. Examples include **Grade management** and **Student signatures**.
Modules are self-contained units of functionality that can be added, removed, or
updated independently. Examples include **Grade management** and **Student
signatures**.
### 9. **How do I create a new module?**
To create a new module, follow the [module creation guide](./modules). Each module must be placed in the `routes/(apps)/` folder and follow the specified structure.
To create a new module, follow the [module creation guide](./modules). Each
module must be placed in the `routes/(apps)/` folder and follow the specified
structure.
### 10. **Can I customize existing modules?**
Yes! PolyMPR’s modular design makes it easy to customize existing modules. Simply modify the relevant files in the module’s folder.
Yes! PolyMPR’s modular design makes it easy to customize existing modules.
Simply modify the relevant files in the module’s folder.
### 11. **How do I add a new feature to PolyMPR?**
You can add new features by creating a custom module or extending an existing one.
You can add new features by creating a custom module or extending an existing
one.
## Troubleshooting 🛠️
### 12. **I’m getting a permission error when running PolyMPR. What should I do?**
Deno requires explicit permissions to access files, networks, and environments. Run the application with the necessary flags:
Deno requires explicit permissions to access files, networks, and environments.
Run the application with the necessary flags:
```bash
deno run --allow-net --allow-read --allow-env main.ts
```
### 13. **Docker isn’t working. What could be the issue?**
Ensure Docker is installed and running on your system. Check the logs for errors and verify that you have sufficient resources (e.g., memory and CPU) allocated.
Ensure Docker is installed and running on your system. Check the logs for errors
and verify that you have sufficient resources (e.g., memory and CPU) allocated.
### 14. **I can’t access the application at `https://localhost`. What’s wrong?**
Make sure the application is running and there are no errors in the terminal. If you’re using Docker, ensure the container is up.
Make sure the application is running and there are no errors in the terminal. If
you’re using Docker, ensure the container is up.
## Community and Support 🤝
### 15. **Where can I get help if I’m stuck?**
You can:
- Join the [GitHub Discussions](https://github.com/fedyna-k/PolyMPR/discussions) to ask questions and share ideas.
- Report issues on the [Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues).
- Consult the [documentation](https://github.com/fedyna-k/PolyMPR/wiki) for detailed guides and tutorials.
- Join the [GitHub Discussions](https://github.com/fedyna-k/PolyMPR/discussions)
to ask questions and share ideas.
- Report issues on the
[Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues).
- Consult the [documentation](https://github.com/fedyna-k/PolyMPR/wiki) for
detailed guides and tutorials.
### 16. **How can I contribute to PolyMPR?**
We welcome contributions! Check out the [contributing guide](/contributing) to learn how to submit pull requests, report issues, or suggest new features.
We welcome contributions! Check out the [contributing guide](/contributing) to
learn how to submit pull requests, report issues, or suggest new features.
### 17. **Is there a community forum or chat for PolyMPR?**
Yes! Join the [PolyMPR Discord server]() to connect with other users and developers.
Yes! Join the [PolyMPR Discord server]() to connect with other users and
developers.
## Licensing and Usage 📜
### 18. **What license is PolyMPR released under?**
PolyMPR is open-source and released under the **MIT License**. You’re free to use, modify, and distribute the code as per the license terms.
PolyMPR is open-source and released under the **MIT License**. You’re free to
use, modify, and distribute the code as per the license terms.
## Next Steps 🚀
If you didn’t find the answer to your question here, check out the following resources:
- **[Installation Guide](./installation)**: Learn how to set up PolyMPR on your local machine to start development. 🖥️
- **[Modules](./modules)**: Learn how to create modules in PolyMPR. 🧩
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's CLI. 📄
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and improvements. 📰
If you didn’t find the answer to your question here, check out the following
resources:
Thank you for using PolyMPR! If you have additional questions, feel free to reach out to the community. Happy coding! 💻✨
- **[Installation Guide](./installation)**: Learn how to set up PolyMPR on your
local machine to start development. 🖥️
- **[Modules](./modules)**: Learn how to create modules in PolyMPR. 🧩
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out
of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's
CLI. 📄
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and
improvements. 📰
Thank you for using PolyMPR! If you have additional questions, feel free to
reach out to the community. Happy coding! 💻✨
Home.md
+43 -18
@@ -1,40 +1,65 @@
# ✨ Welcome to the PolyMPR Wiki ✨
✨ **PolyMPR** ✨ (Poly Management Platform for Resources) is a modern, module-based framework built on **Deno** and **Fresh**, designed to streamline the transition of the **INFO department** to cloud-based solutions for **Human Resources (HR)** management. This wiki serves as the central hub for documentation, guides, and resources to help you understand and extend PolyMPR.
✨ **PolyMPR** ✨ (Poly Management Platform for Resources) is a modern,
module-based framework built on **Deno** and **Fresh**, designed to streamline
the transition of the **INFO department** to cloud-based solutions for **Human
Resources (HR)** management. This wiki serves as the central hub for
documentation, guides, and resources to help you understand and extend PolyMPR.
## What is PolyMPR? 🤔
PolyMPR is a lightweight, scalable, and maintainable framework that simplifies the process of migrating HR systems to the cloud. ☁️
PolyMPR is a lightweight, scalable, and maintainable framework that simplifies
the process of migrating HR systems to the cloud. ☁️
By leveraging Deno's secure runtime and Fresh's edge-ready web framework, PolyMPR provides a robust foundation for building and managing HR applications. Its modular architecture ensures that adding new features or maintaining existing ones is seamless and efficient. 🛠️
By leveraging Deno's secure runtime and Fresh's edge-ready web framework,
PolyMPR provides a robust foundation for building and managing HR applications.
Its modular architecture ensures that adding new features or maintaining
existing ones is seamless and efficient. 🛠️
### Key Features: 🔑
- **Modular Design**: Easily add, remove, or update features without disrupting the entire system. 🧩
- **Cloud-Native**: Built for the cloud, enabling seamless integration with cloud services (amU DataCenter). ☁️
- **Modular Design**: Easily add, remove, or update features without disrupting
the entire system. 🧩
- **Cloud-Native**: Built for the cloud, enabling seamless integration with
cloud services (amU DataCenter). ☁️
- **Deno-Powered**: Utilizes Deno's secure runtime for TypeScript. 🦕
- **Fresh Framework**: Delivers fast, edge-ready web applications with minimal overhead. ⚡
- **Fresh Framework**: Delivers fast, edge-ready web applications with minimal
overhead. ⚡
- **HR-Focused**: Tailored to meet the unique needs of INFO's HR. 👩‍💼👨‍💼
## Why PolyMPR? ❓
- **Ease of Maintenance**: The modular approach ensures that updates and bug fixes are isolated, reducing downtime and complexity. 🛠️
- **Scalability**: Designed to grow with your organization, PolyMPR can handle increasing workloads with ease. 📈
- **Security**: Built on Deno, PolyMPR benefits from its secure-by-default runtime, reducing vulnerabilities. 🔒
- **Students-Driven**: PolyMPR is open-source and encourages collaboration to continuously improve the platform. 🌍
- **Ease of Maintenance**: The modular approach ensures that updates and bug
fixes are isolated, reducing downtime and complexity. 🛠️
- **Scalability**: Designed to grow with your organization, PolyMPR can handle
increasing workloads with ease. 📈
- **Security**: Built on Deno, PolyMPR benefits from its secure-by-default
runtime, reducing vulnerabilities. 🔒
- **Students-Driven**: PolyMPR is open-source and encourages collaboration to
continuously improve the platform. 🌍
## Explore the Wiki 📚
- **[Installation Guide](./installation)**: Learn how to set up PolyMPR on your local machine to start development. 🖥️
- **[Installation Guide](./installation)**: Learn how to set up PolyMPR on your
local machine to start development. 🖥️
- **[Modules](./modules)**: Learn how to create modules in PolyMPR. 🧩
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's CLI. 📄
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out
of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's
CLI. 📄
- **[FAQs](./faqs)**: Find answers to common questions about PolyMPR. ❓
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and improvements. 📰
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and
improvements. 📰
## Join the Community 🤝
PolyMPR is more than just a framework, it's a community. Whether you're looking to contribute code, report issues, or share ideas, we welcome your participation.
PolyMPR is more than just a framework, it's a community. Whether you're looking
to contribute code, report issues, or share ideas, we welcome your
participation.
- **[GitHub Repository](https://github.com/fedyna-k/PolyMPR)**: Access the source code and contribute to the project. 💻
- **[Discussions](https://github.com/fedyna-k/PolyMPR/discussions)**: Engage with other users and developers. 💬
- **[Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues)**: Report bugs or request new features. 🐛
- **[GitHub Repository](https://github.com/fedyna-k/PolyMPR)**: Access the
source code and contribute to the project. 💻
- **[Discussions](https://github.com/fedyna-k/PolyMPR/discussions)**: Engage
with other users and developers. 💬
- **[Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues)**: Report bugs
or request new features. 🐛
Installation.md
+39 -16
@@ -1,14 +1,23 @@
# Installation Guide 🛠️
Welcome to the PolyMPR installation guide! This page will walk you through the steps to set up PolyMPR on your local machine or cloud environment. Whether you're a developer, system administrator, or HR professional, this guide will help you get started with PolyMPR quickly and efficiently. 🚀
Welcome to the PolyMPR installation guide! This page will walk you through the
steps to set up PolyMPR on your local machine or cloud environment. Whether
you're a developer, system administrator, or HR professional, this guide will
help you get started with PolyMPR quickly and efficiently. 🚀
## Prerequisites 📋
Before you begin, ensure you have the following installed on your system:
1. **Deno**: PolyMPR is built on Deno, so you'll need to install it. If you haven't already, follow the [Deno installation guide](https://deno.land/#installation).
2. **Docker**: Docker is optional but recommended for containerized deployments. Install Docker by following the [official Docker installation guide](https://docs.docker.com/get-docker/).
3. **Git**: You'll need Git to clone the PolyMPR repository. Install Git by following the [official Git installation guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
1. **Deno**: PolyMPR is built on Deno, so you'll need to install it. If you
haven't already, follow the
[Deno installation guide](https://deno.land/#installation).
2. **Docker**: Docker is optional but recommended for containerized deployments.
Install Docker by following the
[official Docker installation guide](https://docs.docker.com/get-docker/).
3. **Git**: You'll need Git to clone the PolyMPR repository. Install Git by
following the
[official Git installation guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
## Step 1: Clone the PolyMPR Repository 📥
@@ -39,9 +48,10 @@ To run PolyMPR locally, use Deno or Docker to start the application:
docker-compose up --build # For deno in docker runtime
```
This command will start the PolyMPR application, and you should see output indicating that the server is running.
This command will start the PolyMPR application, and you should see output
indicating that the server is running.
*Docker will ensure you run on the same context as production.*
_Docker will ensure you run on the same context as production._
## Step 3: Access PolyMPR 🌐
@@ -51,29 +61,42 @@ Once the application is running, open your web browser and navigate to:
https://localhost
```
You should see the PolyMPR homepage, indicating that the installation was successful. 🎉
You should see the PolyMPR homepage, indicating that the installation was
successful. 🎉
## Troubleshooting 🛠️
If you encounter any issues during installation, here are some common troubleshooting steps:
If you encounter any issues during installation, here are some common
troubleshooting steps:
1. **Deno Permissions**: Deno requires explicit permissions to access files, networks, and environments. If you encounter permission errors, try running the application with the necessary flags:
1. **Deno Permissions**: Deno requires explicit permissions to access files,
networks, and environments. If you encounter permission errors, try running
the application with the necessary flags:
```bash
deno run -A main.ts
```
2. **Docker Issues**: If Docker fails to build or run the application, ensure Docker is running and that you have sufficient resources allocated (e.g., memory and CPU).
2. **Docker Issues**: If Docker fails to build or run the application, ensure
Docker is running and that you have sufficient resources allocated (e.g.,
memory and CPU).
3. **Git Errors**: If you encounter issues cloning the repository, ensure you have Git installed and that your internet connection is stable.
3. **Git Errors**: If you encounter issues cloning the repository, ensure you
have Git installed and that your internet connection is stable.
## Next Steps 🚀
Now that you've successfully installed PolyMPR, you're ready to start exploring its features! Check out the following resources to continue your journey:
Now that you've successfully installed PolyMPR, you're ready to start exploring
its features! Check out the following resources to continue your journey:
- **[Modules](./modules)**: Learn how to create modules in PolyMPR. 🧩
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's CLI. 📄
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out
of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's
CLI. 📄
- **[FAQs](./faqs)**: Find answers to common questions about PolyMPR. ❓
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and improvements. 📰
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and
improvements. 📰
Thank you for installing PolyMPR! If you have any questions or need further assistance, feel free to reach out to the community or consult the [FAQs](./faqs). Happy coding! 💻✨
Thank you for installing PolyMPR! If you have any questions or need further
assistance, feel free to reach out to the community or consult the
[FAQs](./faqs). Happy coding! 💻✨
Modules.md
+26 -9
@@ -1,16 +1,23 @@
# PolyMPR Modules 🧩
PolyMPR is designed with a **modulith architecture** to ensure flexibility, scalability, and ease of maintenance. Each module is a self-contained unit that can be added, removed, or updated independently. 📦
PolyMPR is designed with a **modulith architecture** to ensure flexibility,
scalability, and ease of maintenance. Each module is a self-contained unit that
can be added, removed, or updated independently. 📦
## Create Modules 🏗️
Creating modules in PolyMPR is straightforward, thanks to its well-defined structure and conventions. Below, you'll find everything you need to know to build and integrate your own modules into the platform.
Creating modules in PolyMPR is straightforward, thanks to its well-defined
structure and conventions. Below, you'll find everything you need to know to
build and integrate your own modules into the platform.
### Module Structure 🧱
Each module must be placed inside the `routes/(apps)/` folder and follow the structure outlined below. This ensures consistency and makes it easier to maintain and extend the platform.
Each module must be placed inside the `routes/(apps)/` folder and follow the
structure outlined below. This ensures consistency and makes it easier to
maintain and extend the platform.
#### Folder Structure:
```
.
├── api/ # API endpoints for the module
@@ -35,7 +42,8 @@ Here’s a breakdown of each folder and its purpose:
2. **`(_components)/`**:
- Houses shared React components used within the module.
- These components are reusable and can be imported into other parts of the module.
- These components are reusable and can be imported into other parts of the
module.
- Example: A `UserCard.tsx` component for displaying user information.
3. **`(_islands)/`**:
@@ -64,9 +72,11 @@ Here’s a breakdown of each folder and its purpose:
### Creating a New Module 🛠️
To create a new module, you can use the [CLI](./cli):
```bash
pmpr module create <module-name-kebab-case>
```
It will create all the required files for a module.
### Example: User Management Module 👤
@@ -91,11 +101,18 @@ users/
## Next Steps 🚀
Now that you know how to create modules, you can start building and customizing PolyMPR to meet your organization's needs. Check out the following resources to continue your journey:
Now that you know how to create modules, you can start building and customizing
PolyMPR to meet your organization's needs. Check out the following resources to
continue your journey:
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's CLI. 📄
- **[Tutorials](./tutorials)**: Step-by-step guides to help you get the most out
of PolyMPR. 🎓
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's
CLI. 📄
- **[FAQs](./faqs)**: Find answers to common questions about PolyMPR. ❓
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and improvements. 📰
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and
improvements. 📰
Thank you for installing PolyMPR! If you have any questions or need further assistance, feel free to reach out to the community or consult the [FAQs](./faqs). Happy coding! 💻✨
Thank you for installing PolyMPR! If you have any questions or need further
assistance, feel free to reach out to the community or consult the
[FAQs](./faqs). Happy coding! 💻✨
Releases.md
+2 -2
@@ -1,9 +1,9 @@
# Release Notes 📰
*PolyMPR uses [SemVer](https://semver.org/lang/fr/) for versionning.*
_PolyMPR uses [SemVer](https://semver.org/lang/fr/) for versionning._
## 0.0.1-alpha
- Created PolyMPR base monolith.
- Created module loading core.
- Created documentation.
- Created documentation.
Tutorials.md
+6 -3
@@ -4,8 +4,11 @@ Work in progress...
## Explore the Wiki 📚
- **[Installation Guide](./installation)**: Learn how to set up PolyMPR on your local machine to start development. 🖥️
- **[Installation Guide](./installation)**: Learn how to set up PolyMPR on your
local machine to start development. 🖥️
- **[Modules](./modules)**: Learn how to create modules in PolyMPR. 🧩
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's CLI. 📄
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's
CLI. 📄
- **[FAQs](./faqs)**: Find answers to common questions about PolyMPR. ❓
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and improvements. 📰
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and
improvements. 📰
_Footer.md
+1 -1
@@ -1 +1 @@
PolyMPR is open-source and released under the **MIT License** 📜
PolyMPR is open-source and released under the **MIT License** 📜