Skip to content

FAQs

Jump to bottom
Kevin FEDYNA edited this page Jan 28, 2025 · 3 revisions

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. 🛠️

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.

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.

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.

Installation and Setup 🛠️

5. How do I install PolyMPR?

To install PolyMPR, clone the GitHub repository and follow the installation guide. You’ll need Deno and optionally Docker for containerized deployments.

git clone https://github.com/fedyna-k/PolyMPR.git
cd PolyMPR
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.

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.

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.

9. How do I create a new module?

To create a new module, follow the module creation guide. 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.

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.

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 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.

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.

Community and Support 🤝

15. Where can I get help if I’m stuck?

You can:

16. How can I contribute to PolyMPR?

We welcome contributions! Check out the contributing guide 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.

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.

Next Steps 🚀

If you didn’t find the answer to your question here, check out the following resources:

  • Installation Guide: Learn how to set up PolyMPR on your local machine to start development. 🖥️
  • Modules: Learn how to create modules in PolyMPR. 🧩
  • Tutorials: Step-by-step guides to help you get the most out of PolyMPR. 🎓
  • CLI Documentation: Dive into the technical details of PolyMPR's CLI. 📄
  • Release Notes: 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! 💻✨

PolyMPR is open-source and released under the MIT License 📜

Clone this wiki locally