Dev

.github/workflows/deploy-documentation.yml

@@ -0,0 +1,27 @@
+name: deploy-documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          sphinx-build docs/source _build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

.gitignore

@@ -1,5 +1,6 @@
 # IDE
 .idea/
+.vscode/
 
 # Documentation
 build/

README.md

@@ -1 +1,104 @@
-# AutoTasker
+# AREA
+
+AREA (Action Reaction) aims to connect multiple services together, similar to IFTTT.<br>
+With AREA, you can create automated workflows that integrate various services and perform actions based on specific triggers.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Installation & Usage](#installation--usage)
+- [Documentation](#documentation)
+    - [Requirements](#requirements)
+    - [Usage](#usage)
+- [Tests](#tests)
+- [License](#license)
+- [Contributors](#contributors)
+
+## Getting Started
+
+### Prerequisites
+
+- vite js
+- go
+- docker
+
+### Installation & Usage
+
+<details>
+<summary>Click to expand</summary>
+
+1. Clone the repo
+```sh
+git clone [email protected]:ASM-Studios/AREA.git
+```
+
+2. Install NPM packages
+```sh
+cd AREA/client-web
+npm install
+```
+
+3. Install Go packages
+```sh
+cd AREA/server
+<TODO>
+```
+
+4. Run the project
+```sh
+cd AREA/client-web
+npm run start
+```
+```sh
+cd AREA/server
+go run ./...
+```
+</details>
+
+### Documentation
+
+#### Requirements
+
+<details>
+<summary>Click to expand</summary>
+
+- Python
+- sphinx
+- spinx_rtd_theme
+
+sphinx and sphinx_rtd_theme can be installed using pip
+
+</details>
+
+#### Usage
+
+The documentation is automatically built and deployed to GitHub Pages when a push is made to the `main` branch.
+
+You can consult the documentation online at [AREA Documentation](https://asm-studios.github.io/AREA/).
+
+You can build the documentation locally by running the following command:
+```sh
+cd AREA/docs
+make docs
+```
+
+### Tests
+
+// TODO
+
+## License
+
+![Github License](https://img.shields.io/badge/license-GLP3.0-yellowgreen.svg)
+
+This project is licensed under the terms of the GLP3.0 license. See the [LICENSE](LICENSE) file for details.
+
+## Contributors
+
+This project was developed by:
+
+- Maël RABOT
+- Mathieu COULET
+- Mathieu BOREL
+- Charles MADJERI
+- Samuel BRUSCHET

client_web/package.json

@@ -5,6 +5,7 @@
   "type": "module",
   "main": "electron.js",
   "scripts": {
+    "start": "mkcert -install && mkcert localhost && vite",
     "dev": "mkcert -install && mkcert localhost && vite",
     "production": "vite --mode production",
     "build": "tsc -b && vite build",