ContWatch 2.0

.github/workflows/client.yaml

@@ -0,0 +1,31 @@
+name: Client CI
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 22.x ]
+    defaults:
+      run:
+        working-directory: ./src/client
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Lint
+        run: npm run lint
+      - name: Biome
+        run: npm run biome
+      - name: Stylelint
+        run: npm run stylelint
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm test

.gitignore

@@ -1,34 +1,30 @@
-# JetBrains
+# JetBrains IDE
 .idea/
 
 # Python
 __pycache__/
+*.pyc
 
 # Node.js
 node_modules
-package-lock.json
 
-# Build
-modules/web_server/static/js
-modules/web_server/static/styles/*.css
-modules/web_server/static/styles/*.css.map
-!modules/web_server/static/styles/main.css
-!modules/web_server/static/styles/main.css.map
+# Next.js
+.next/
 
 # Logs
 *.log*
 
-# Configs
-*.json
-
-# SASS
-.sass-cache/
-
 # Database
 *.sqlite*
 
+# Environment
+*.env*
+
 # Nohup
 nohup.out
 
-# Static symlink
-/static
+# Config
+config.json
+
+# Eslint
+.eslintcache

README.md

@@ -1,26 +1,40 @@
 # ContWatch
 
-System for controlling single-board microcontrollers powered by Python.
+Scalable system for IoT automation. Offers an intuitive web interface for controlling and monitoring devices.
 
-## Python dependencies
-
-If you use [`apt`](https://en.wikipedia.org/wiki/APT_(software)) as your package manager, you can run:
-
-```shell
-xargs -a dependencies.txt sudo apt-get install
-```
-
-As an alternative you can use [`pip`](https://en.wikipedia.org/wiki/Pip_(package_manager)):
+## Run server
+Make sure you have [pipenv](https://pipenv.pypa.io/en/latest/) installed.
 
 ```shell
-pip3 install -r requirements.txt --user
+cd src/server
+pipenv install
+pipenv run server
 ```
 
-## Usage
+## Run client
+Make sure you have [node.js](https://nodejs.org/en) installed.
 
 ```shell
+cd src/client
 npm install
+npm run build
 npm start
 ```
 
-Python codebase is formatted with [black](https://github.com/psf/black#readme) and TypeScript codebase with [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint#readme).
+## Credits
+This project is available thanks to following technologies and their communities:
+
+| Name                                                       | Used for                 |
+|------------------------------------------------------------|--------------------------|
+| [Python](https://www.python.org/)                          | Server language          |
+| [Flask](https://flask.palletsprojects.com/)                | Server framework         |
+| [PonyORM](https://ponyorm.org/)                            | Server database          |
+| [Black](https://black.readthedocs.io/en/stable/index.html) | Server code formatting   |
+| [Node.js](https://nodejs.org/en)                           | Client codebase          |
+| [TypeScript](https://www.typescriptlang.org/)              | Client language          |
+| [Next.js](https://nextjs.org/)                             | Client backend           |
+| [React](https://reactjs.org/)                              | Client framework         |
+| [Redux](https://redux.js.org/)                             | Client state management  |
+| [ESLint](https://eslint.org/)                              | Client code linting      |
+| [Prettier](https://prettier.io/)                           | Client code formatting   |
+| [Stylelint](https://stylelint.io/)                         | Client styles linting    |