diff --git a/README.md b/README.md index d1c3cbf..a92f2ac 100644 --- a/README.md +++ b/README.md @@ -123,179 +123,3 @@ Pour rendre le projet exportable : - Tout est containerisé (Docker) - Config Keycloak exporté (JSON disponible dans le dossier `export_keycloak`) - `docker-compose.yml`, `Caddyfile`, fichier disponible dans le repo - - - - -repo-top-language -repo-language-count - -Built with the tools and technologies: - -Flask -JSON -Keycloak -GNU%20Bash -MariaDB -
-Docker -Python -Mattermost -bat - - -
- ---- - -## Table of Contents - -- [Overview](#overview) -- [Getting Started](#getting-started) - - [Prerequisites](#prerequisites) - - [Installation](#installation) - - [Usage](#usage) - - [Testing](#testing) -- [Contributing](#contributing) -- [Acknowledgment](#acknowledgment) - ---- - -## Overview - -Gesthub is a powerful developer tool designed to streamline the setup and management of full-stack applications by integrating essential services into a cohesive environment. - -**Why Gesthub?** - -This project simplifies the development process, allowing developers to focus on building features rather than managing infrastructure. The core features include: - -- 🚀 **Docker Compose Configuration:** Simplifies orchestration of multiple services, reducing setup complexity. -- 🌐 **Local Domain Management:** Scripts to add local domain entries streamline access to services, enhancing the development experience. -- 🔒 **Integrated User Authentication:** Utilizes Keycloak for secure user management, addressing security concerns. -- ⚙️ **Seamless Routing and Load Balancing:** Caddyfile configuration ensures efficient request handling, improving performance. -- 🎨 **User-Friendly Interface:** Responsive design enhances collaboration and user experience. -- 📊 **Centralized Data Management:** Structured storage for advertisements improves data handling capabilities. - ---- - -## Getting Started - -### Prerequisites - -This project requires the following dependencies: - -- **Programming Language:** Shell -- **Package Manager:** Bash -- **Container Runtime:** Docker - -### Installation - -Build gesthub from the source and intsall dependencies: - -1. **Clone the repository:** - - ```sh - ❯ git clone https://github.com/M1n-0/gesthub - ``` - -2. **Navigate to the project directory:** - - ```sh - ❯ cd gesthub - ``` - -3. **Install the dependencies:** - -**Using [docker](https://www.docker.com/):** - -```sh -❯ docker build -t M1n-0/gesthub . -``` -**Using [bash](https://www.gnu.org/software/bash/):** - -```sh -❯ chmod +x {entrypoint} -``` - -### Usage - -Run the project with: - -**Using [docker](https://www.docker.com/):** - -```sh -docker run -it {image_name} -``` -**Using [bash](https://www.gnu.org/software/bash/):** - -```sh -./{entrypoint} -``` - -### Testing - -Gesthub uses the {__test_framework__} test framework. Run the test suite with: - -**Using [docker](https://www.docker.com/):** - -```sh -echo 'INSERT-TEST-COMMAND-HERE' -``` -**Using [bash](https://www.gnu.org/software/bash/):** - -```sh -bats *.bats -``` - ---- - -## Contributing - -- **💬 [Join the Discussions](https://github.com/M1n-0/gesthub/discussions)**: Share your insights, provide feedback, or ask questions. -- **🐛 [Report Issues](https://github.com/M1n-0/gesthub/issues)**: Submit bugs found or log feature requests for the `gesthub` project. -- **💡 [Submit Pull Requests](https://github.com/M1n-0/gesthub/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs. - -
-Contributing Guidelines - -1. **Fork the Repository**: Start by forking the project repository to your github account. -2. **Clone Locally**: Clone the forked repository to your local machine using a git client. - ```sh - git clone https://github.com/M1n-0/gesthub - ``` -3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name. - ```sh - git checkout -b new-feature-x - ``` -4. **Make Your Changes**: Develop and test your changes locally. -5. **Commit Your Changes**: Commit with a clear message describing your updates. - ```sh - git commit -m 'Implemented new feature x.' - ``` -6. **Push to github**: Push the changes to your forked repository. - ```sh - git push origin new-feature-x - ``` -7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations. -8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution! -
- -
-Contributor Graph -
-

- - - -

-
- ---- - -## Acknowledgments - -- Credit `contributors`, `inspiration`, `references`, etc. - -
⬆ Return
- ----