From e7f5bed7f6f71a20603bc94c21bc20975fc9a5f8 Mon Sep 17 00:00:00 2001 From: Bastien DUMONT <bdumont@grandlyon.com> Date: Thu, 9 Feb 2023 14:27:07 +0000 Subject: [PATCH] Update README.md --- README.md | 42 +----------------------------------------- 1 file changed, 1 insertion(+), 41 deletions(-) diff --git a/README.md b/README.md index 7148c7d..f29cd60 100644 --- a/README.md +++ b/README.md @@ -4,44 +4,4 @@ Ecolyo Agent is the backoffice for the Ecolyo app. This repository contains the backend part of this backoffice. -# Features - -- Authentification using OAuth2 - -- Connected admins can use an API to edit and save different sections of the newsletters that will be sent to Ecolyo users - -- Exposes a public route to get the sections of a specific or the last newsletter - -# How to setup : - -This backend should be deployed with the frontend from [this repo](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client) - -However this backend can be run in standalone : - -- Clone the repository - -- Set a .env file at the root and add all variables declared in the [template.env](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server/-/blob/dev/.env.template) - -- (**Optionnal**) you can create new certificates by running `cd dev_certificates && ./generate-certificates.sh` - -- Run `docker-compose up -d` - -Once deployed, you can access to a Swagger documentation of the API on https://${HOSTNAME}/swagger/index.html - -## Launch locally - -Launch all necessary services : - -- Run `docker-compose up -d` - -In local you can access phpmyadmin interface to manage the database : http://localhost:8008 - -Launch the server by pressing F5 on vscode, you will see the logs on the debug console. - -All API routes are available on https://localhost:1443 - -## Build image for local - -``` -docker build . -t backoffice-server -``` +[check documentation here](https://doc.self-data.alpha.grandlyon.com/ecolyo-agent/technical/getting_started/#ecolyo-agent-server) -- GitLab