Add Github Actions with Ruff (#31)

* Update readme

* Add Github Actions

* Run linters only on push of main branches

.github/workflows/linters.yml

@@ -0,0 +1,18 @@
+name: Run Linters
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: 'format --check'

README.md

@@ -31,11 +31,18 @@ apt install just
 
 Others: [link](https://github.com/casey/just?tab=readme-ov-file#packages)
 
-### Setup Database
+### Setup poetry
+```shell
+pip install poetry
+```
+
+Other ways: [link](https://python-poetry.org/docs/#installation)
+
+### Setup Postgres (16.3)
 ```shell
 just up
 ```
-### Setup Dependencies & Environment variables
+### Copy the environment file and install dependencies
 1. `cp .env.example .env`
 2. `poetry install`