ci: update CI for releases

.github/workflows/release.yml

@@ -0,0 +1,53 @@
+name: Release
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  release-frontend:
+    name: Release Frontend
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Install dependencies
+        run: npm ci
+        working-directory: frontend
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release
+        working-directory: frontend
+
+  release-backend:
+    name: Release Backend
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Install dependencies
+        run: npm ci
+        working-directory: backend
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release
+        working-directory: backend

README.md

@@ -1,53 +1,95 @@
-# Realt Properties Map
-|  |  |
-| -- | -- |
-| <img src="https://github.com/mfrederic/realt-properties-map/blob/main/frontend/public/RealT_Logo.png?raw=true" width="300" alt="RealT Properties Map Logo"> | __RealT Properties Map__ is a community project aiming at giving you a clear view of RealT protfolio and/or your own. |
+<div align="center">
 
-Access the web app here: __[RealT Properties Map](https://rpm.mighte.app/)__
+[![Version][version-shield]][version-url]
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
 
-This project uses several external services to get its data from (Realtoken Dashboard, realtoken-thegraph GQL resources)
+<img src="https://github.com/mfrederic/realt-properties-map/blob/main/frontend/public/RealT_Logo.png?raw=true" width="300" alt="RealT Properties Map Logo">
 
-__Important notice__: RealT Properties Map is __NOT__ related to [RealT](https://realt.co/)
+# RealT Properties Map
 
-## Run project
+A community-driven project providing an interactive visualization of RealT portfolio properties.
 
-To run the project using Docker, you can just use the root `docker-compose.yml` file using the following command.
-```sh
-docker compose up
-```
+[View Demo](https://rpm.mighte.app/) · [Report Bug](https://github.com/mfrederic/realt-properties-map/issues) · [Request Feature](https://github.com/mfrederic/realt-properties-map/issues)
 
-### Run separatly
+</div>
 
-Both frontend and backend uses .env file. You can create them from the `example.env` files.
+## 📋 About The Project
 
-To run the backend, follow these instructions
+RealT Properties Map helps you visualize RealT portfolio properties and track your own investments. The project integrates data from multiple sources including:
+- Realtoken Dashboard
+- realtoken-thegraph GQL resources
 
-```sh
-cd ./backend
+> **Important:** This project is not officially affiliated with [RealT](https://realt.co/)
 
-npm install
+## 🚀 Getting Started
 
-npm run dev
-```
+### Built With
+- [React](https://reactjs.org/) - Frontend framework
+- [Node.js](https://nodejs.org/) - Backend runtime
+- [Express](https://expressjs.com/) - Backend framework
+- [GraphQL](https://graphql.org/) - API query language
+- [Leaflet](https://leafletjs.com/) - Interactive maps
+- [Docker](https://www.docker.com/) - Containerization
 
-The backend will be made available on `http://localhost:3000` and expect requests from the frontend on `http://localhost:3010`.
+### Using Docker (Recommended)
 
-To run the frontend, follow these instructions
+The easiest way to run the project is using Docker:
 
-```sh
-cd ./frontend
+```bash
+docker compose up
+```
+
+### Manual Setup
+This section describes how to setup the project using individual services. This can be useful for development purposes.
 
+#### Backend Setup
+```bash
+cd ./backend
 npm install
+npm run dev
+```
+The backend will run on `http://localhost:3000`
 
+#### Frontend Setup
+```bash
+cd ./frontend
+npm install
 npm run start
 ```
-
-The frontend will be made available on `http://localhost:3010`.
-
-## Contributing
-
-Contributions are welcome. Please make sure to update tests as appropriate.
-
-## License
-
-This project is licensed under the Apache-2.0 License.
+The frontend will run on `http://localhost:3010`
+
+### Environment Configuration
+Both frontend and backend require environment configuration. Copy the provided `example.env` files and modify as needed:
+- `backend/example.env` → `backend/.env`
+- `frontend/example.env` → `frontend/.env`
+
+## 🤝 Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 📝 License
+
+Distributed under the Apache-2.0 License. See `LICENSE` for more information.
+
+[version-shield]: https://img.shields.io/github/v/tag/mfrederic/realt-properties-map.svg?label=version&style=for-the-badge
+[version-url]: https://github.com/mfrederic/realt-properties-map/tags
+[contributors-shield]: https://img.shields.io/github/contributors/mfrederic/realt-properties-map.svg?style=for-the-badge
+[contributors-url]: https://github.com/mfrederic/realt-properties-map/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/mfrederic/realt-properties-map.svg?style=for-the-badge
+[forks-url]: https://github.com/mfrederic/realt-properties-map/network/members
+[stars-shield]: https://img.shields.io/github/stars/mfrederic/realt-properties-map.svg?style=for-the-badge
+[stars-url]: https://github.com/mfrederic/realt-properties-map/stargazers
+[issues-shield]: https://img.shields.io/github/issues/mfrederic/realt-properties-map.svg?style=for-the-badge
+[issues-url]: https://github.com/mfrederic/realt-properties-map/issues
+[license-shield]: https://img.shields.io/github/license/mfrederic/realt-properties-map.svg?style=for-the-badge
+[license-url]: https://github.com/mfrederic/realt-properties-map/blob/master/LICENSE.txt

backend/.releaserc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  branches: ['main'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    "@semantic-release/changelog",
+    ['@semantic-release/git', {
+      assets: ['package.json'],
+      message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
+    }],
+    '@semantic-release/github'
+  ]
+};