diff --git a/README.md b/README.md index 9e429a0..e03f3ae 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# For-democracy +# For Democracy A mobile app designed to help players organize and participate in events for the game [Helldivers 2](https://store.steampowered.com/app/553850/HELLDIVERS_2). @@ -6,7 +6,7 @@ This is our last project for our 5th year at ESGI (second semester). ## Content -- [For-democracy](#for-democracy) +- [For Democracy](#for-democracy) - [Content](#content) - [Features](#features) - [Mobile](#mobile) @@ -48,6 +48,7 @@ The main visual part of the project. It is used by players to organize and parti - Create private groups and use a code to invite friends - Plan missions with objectives in your group - Join your friends' missions and choose your stratagems +- Notifications in real-time with Firebase - And more ! #### Screenshots @@ -72,10 +73,21 @@ The main visual part of the project. It is used by players to organize and parti ### API A RESTful API to process the official Helldivers data and expose it through endpoints. +See the [Swagger documentation](https://democracy.yam-yam.dev/swagger/index.html). #### API features - Made with [Go](https://go.dev) and [Gin](https://github.com/gin-gonic/gin) +- Steam OAuth +- Gathering of Helldivers 2 game data from various sources +- Processing of gathered data (stats, events, etc.) +- Real-time events update with SSE +- Swagger documentation +- Migration system with Atlas +- Docker configuration for development and production +- Firebase client for notifications +- Stateless API with JWT authentication +- Cron jobs to process data > [!NOTE] > Also see the [API README](api/README.md) for more information. diff --git a/api/README.md b/api/README.md index 48bd746..52abbf5 100644 --- a/api/README.md +++ b/api/README.md @@ -2,7 +2,22 @@ This is the API for the project. -### Prerequisites +## Content + +- [API](#api) + - [Content](#content) + - [Prerequisites](#prerequisites) + - [Getting Started](#getting-started) + - [Using Docker](#using-docker) + - [Without Docker](#without-docker) + - [Migrations](#migrations) + - [Collector](#collector) + - [Running unit tests](#running-unit-tests) + - [Building the API](#building-the-api) + - [Development Environment](#development-environment) + - [Production Environment](#production-environment) + +## Prerequisites - [Docker](https://docs.docker.com/get-docker/) or [Go](https://golang.org/doc/install) - [Firebase](https://firebase.google.com/docs/web/setup) diff --git a/mobile/README.md b/mobile/README.md index 935f15d..78356ee 100644 --- a/mobile/README.md +++ b/mobile/README.md @@ -2,6 +2,16 @@ This is the mobile app for the project. +## Content + +- [Mobile](#mobile) + - [Content](#content) + - [Getting Started](#getting-started) + - [Using docker (Android only)](#using-docker-android-only) + - [Prerequisites](#prerequisites) + - [Add service](#add-service) + - [Run app](#run-app) + ## Getting Started Copy the `.env.example` file to `.env` and fill in the necessary values. diff --git a/web/README.md b/web/README.md index 910349b..6a85d1d 100644 --- a/web/README.md +++ b/web/README.md @@ -1,3 +1,8 @@ # Web This is the web interface for the administation of the project. + +## Content + +- [Web](#web) + - [Content](#content)