{"id":21739316,"url":"https://github.com/mlargeot/area","last_synced_at":"2025-04-13T03:29:01.783Z","repository":{"id":264606825,"uuid":"890384118","full_name":"mlargeot/Area","owner":"mlargeot","description":"ACTION-REACTION CREATE AN AUTOMATION PLATFORM","archived":false,"fork":false,"pushed_at":"2025-01-19T21:57:53.000Z","size":31662,"stargazers_count":3,"open_issues_count":7,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T20:49:28.503Z","etag":null,"topics":["backend","database","frontend","mongodb","nestjs","react-native","rest-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mlargeot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-18T13:31:24.000Z","updated_at":"2025-01-19T21:58:10.000Z","dependencies_parsed_at":"2025-01-10T18:30:28.768Z","dependency_job_id":"afd39d79-7fa7-4e91-8a54-f309b4b76618","html_url":"https://github.com/mlargeot/Area","commit_stats":null,"previous_names":["mlargeot/area"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlargeot%2FArea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlargeot%2FArea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlargeot%2FArea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlargeot%2FArea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mlargeot","download_url":"https://codeload.github.com/mlargeot/Area/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248659318,"owners_count":21141116,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","database","frontend","mongodb","nestjs","react-native","rest-api"],"created_at":"2024-11-26T06:08:29.338Z","updated_at":"2025-04-13T03:29:01.775Z","avatar_url":"https://github.com/mlargeot.png","language":"TypeScript","readme":"\u003cdiv style=\"text-align:center\"\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/f92370ae-196c-437a-8437-972641222206\" width=\"400\" alt=\"logo\"/\u003e\n\u003c/div\u003e\n\n# Build \u0026 Run the Project\n\n## Prerequisites\n\nThe only prerequisites for running this project are `Docker` and `ngrok`. Please ensure both Docker and ngrok are installed on your system.\n\n### Docker Installation on Linux\n\nYou can install Docker using the following command:\n\n```bash\nsudo apt update\nsudo apt install docker docker-compose\n```\n\n### Docker Installation on Windows\n\n1. **Download Docker Desktop**:  \n   Go to the [official Docker website](https://www.docker.com/products/docker-desktop) and download Docker Desktop for Windows.\n\n2. **Install Docker Desktop**:  \n   Follow the installation instructions and ensure Docker Desktop is configured to use WSL 2 (if applicable). You may need to enable virtualization in your system's BIOS if it isn't already enabled.\n\n3. **Start Docker Desktop**:  \n   After installation, launch Docker Desktop. Ensure it is running by checking its status in the taskbar.\n\n4. **Verify Installation**:  \n   Open a command prompt or PowerShell and run:\n\n   ```powershell\n   docker --version\n   docker-compose --version\n   ```\n\n   This will confirm that Docker and Docker Compose are correctly installed.\n\n### Using Curl (Alternative)\n\nIf you prefer using `curl`, you can install Docker with this command (Linux):\n\n```bash\ncurl -fsSL https://get.docker.com -o get-docker.sh\nsudo sh get-docker.sh\n```\n\n### Ngrok Installation\n\nTo install **ngrok** on your system, follow the official documentation corresponding to your operating system:\n\n- **Linux**: Refer to the [official Linux installation guide](https://download.ngrok.com/linux) for step-by-step instructions.\n- **Windows**: Follow the [official Windows installation guide](https://download.ngrok.com/windows?tab=download) to download and set up ngrok.\n\nFor additional installation methods or troubleshooting, visit the [ngrok installation documentation](https://download.ngrok.com/).\n\nThen follow the `ngrok` configuration:\n```bash\nngrok config add-authtoken \u003ctoken\u003e\n```\n\n## Run the Project\n\n### Setup Ngrok\n\nAfter installing the prerequisites, configure ngrok to expose `localhost:8080` to the internet.\n\n```bash\nngrok http 8080\n```\n\nCopy the generated link and add it to the .env file located in the `backend/` directory using the following format:\n\n```bash\nWEBHOOK_ENDPOINT=$ENDPOINT \n#(e.g : WEBHOOK_ENDPOINT=https://644a-163-5-2-51.ngrok-free.app/)\n```\n\nOnce ngrok is configured, you can proceed to build and run the project using the following commands.\n\n### Linux / macOS\n\n```bash\n# Build and run the project\nsudo docker-compose up --build\n\n# Build and run the project in the background\nsudo docker-compose up --build -d\n```\n\n### Windows (Command Prompt or PowerShell)\n\nFor Windows, `sudo` is not required. Use the following commands:\n\n```powershell\n# Build and run the project\ndocker-compose up --build\n\n# Build and run the project in the background\ndocker-compose up --build -d\n```\n\n## Stop and Remove the Project\n\nTo stop and remove the project, use the following command:\n\n### Linux / macOS\n\n```bash\nsudo docker-compose down -v\n```\n\n### Windows (Command Prompt or PowerShell)\n\n```powershell\ndocker-compose down -v\n```\n\n## Documentation\n### API Documentation\n\nFor more details about the API, feel free to check out the [AR3M API documentation](./docs/README_API.md). If you cloned the repository, you can view this documentation locally by running the following command:\n\n```bash\ncat ./docs/README_API.md\n```\n\n### Global Documentation\n\nThe complete documentation for the project is available on the [project wiki](https://github.com/mlargeot/Area/wiki).\n\n## Cheat Warning\n\nThis repository is public for several reasons. As it is part of a third-year school project at EPITECH, please refrain from using it for your own EPITECH projects to avoid being flagged for cheating (-42). We are not responsible for any misuse of our repository.\n\n## Authors\n\n\u003ctable\u003e\n    \u003ctbody\u003e\n        \u003ctr\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/mlargeot\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/114756247?v=4\" width=\"100px;\" alt=\"mlargeot\"/\u003e\u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003emlargeot\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/MaxenceLgt\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/114743051?v=4\" width=\"100px;\" alt=\"MaxenceLgt\"/\u003e\u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eMaxenceLgt\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/DiaboloAB\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/109909203?v=4\" width=\"100px;\" alt=\"DiaboloAB\"/\u003e\u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eDiaboloAB\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/Raphael-Mabille\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/114739950?v=4\" width=\"100px;\" alt=\"Raphael-Mabille\"/\u003e\u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eRaphael-Mabille\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/MrMarmotte\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/114657171?v=4\" width=\"100px;\" alt=\"MrMarmotte\"/\u003e\u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eMrMarmotte\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n    \u003c/tbody\u003e\n\u003c/table\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlargeot%2Farea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmlargeot%2Farea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlargeot%2Farea/lists"}