Added all files

2025-01-28 23:41:10 +01:00
parent a9a2f6f390
commit ccbec884e8
3 changed files with 104 additions and 2 deletions
@@ -0,0 +1,15 @@
+# Contributing
+
+Thank you for your interest in contributing to our project! We appreciate your help in making this project better. To get started with contributing, please refer to our [Contributing Guide](https://github.com/fedyna-k/PolyMPR/wiki/Contributing) on the project's wiki.
+
+The Contributing Guide provides detailed information on how to:
+
+- Set up your development environment
+- Submit issues and feature requests
+- Fork the repository and create pull requests
+- Follow our coding standards and guidelines
+- Report bugs and suggest improvements
+
+If you have any questions or need further assistance, feel free to reach out to us by opening an issue or contacting the maintainers directly.
+
+Happy coding! 💻✨
@@ -0,0 +1,18 @@
+Copyright 2025 - PolyMPR team @ Polytech Marseille
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -1,4 +1,73 @@
 # ✨ PolyMPR ✨

-The ✨ Poly Module de Pilotage des Ressources ✨ is the ultimate tool to handle
-various HR task in the INFO department.
+**PolyMPR** (Poly Management Platform for Resources) is a modern, modular framework built on **Deno** and **Fresh**, designed to help organizations transition their HR systems to the cloud. With its **modulith architecture**, PolyMPR simplifies the development, deployment, and maintenance of HR applications, making it the perfect choice for teams looking to modernize their workflows. 🌐
+
+## 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). ☁️
+- **Deno-Powered**: Utilizes Deno's secure runtime for TypeScript. 🦕
+- **Fresh Framework**: Delivers fast, edge-ready web applications with minimal overhead. ⚡
+- **HR-Focused**: Tailored to meet the unique needs of INFO's HR. 👩‍💼👨‍💼
+
+## Getting Started 🛠️
+
+### Prerequisites
+- **Deno**: Install Deno by following the [official guide](https://deno.land/#installation).
+- **Docker** (optional): Install Docker for containerized deployments. Follow the [Docker installation guide](https://docs.docker.com/get-docker/).
+
+### Installation
+1. Clone the PolyMPR repository:
+   ```bash
+   git clone https://github.com/fedyna-k/PolyMPR.git
+   cd PolyMPR
+   ```
+2. Start the application:
+   ```bash
+   deno task start
+   ```
+3. Access the application at `https://localhost`.
+
+For detailed installation instructions, check out the [Installation Guide](./wiki/installation).
+
+## Modules Overview 🧩
+
+PolyMPR comes with a variety of modules to streamline HR processes.
+
+To learn how to create a module, visit the [Module Overview](./wiki/modules).
+
+## CLI Documentation 📄
+
+The **PolyMPR CLI** simplifies development tasks. Here are some common commands:
+
+- Create a new module:
+  ```bash
+  pmpr module create <module-name-kebab-case>
+  ```
+
+For detailed CLI usage, check out the [CLI Documentation](./wiki/cli).
+
+## Contributing 🤝
+
+We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated. Here’s how to get started:
+
+1. Create a new issue.
+2. Create a new branch for your changes:
+   ```bash
+   git checkout -b PMPR-:ISSUE_ID:
+   ```
+3. Commit your changes and push them to your branch.
+4. Submit a pull request.
+
+For more details, read the [Contributing Guide](./contributing).
+
+## Community and Support 🌟
+
+Join the PolyMPR community to connect with other users and developers:
+
+- **GitHub Discussions**: Ask questions and share ideas. 💬
+- **Issue Tracker**: Report bugs or request features. 🐛
+
+## License 📜
+
+PolyMPR is open-source and released under the **MIT License**. Feel free to use, modify, and distribute it as per the license terms.