docs: update README and TODO

This commit is contained in:
Matthieu Bessat 2023-11-07 18:49:47 +01:00
parent 694e5c9690
commit 3207cce171
2 changed files with 31 additions and 8 deletions

View file

@ -1,12 +1,14 @@
# API/Serveur - associations.espacecondorcet.org
# PageAssos API/Back-end server
This is the code that run the Node.js back-end that allow public-pages website rendering and the API used by the front-end panel.
## Requirements
- Node.js >= 12.18.2
- Yarn >= 1.17 - [Installation Page](https://classic.yarnpkg.com/en/docs/install)
- MongoDB >= v4.2.8
- A SMTP server
- A S3 Bucket
- Runtime: Node.js >= 12.18.2
- Package manager: Yarn >= 1.17 - [Installation Page](https://classic.yarnpkg.com/en/docs/install)
- Database: MongoDB >= v4.2.8
- Emails: any SMTP server (to send emails to organizations)
- Object storage: S3-compatible bucket (to store assets uploaded by organizations)
## Installation
@ -16,7 +18,6 @@ Use the `yarn install` command at the root (take a long time)
Then you have to fill the `.env`. We advise you to copy and paste the `.env.example` file as a example for the real `.env`
## Usage in a development environment
`yarn serve`

22
TODO.md Normal file
View file

@ -0,0 +1,22 @@
## TODO: Things to do
- chore: upgrade Node.js version and all libs
- chore: use a modern Node.js run-time (eg. Bun?)
- feat: allow to host with docker
### fonctionalités utilisateurs
- permettre aux associations un changement de thème ou de style du site
- faciliter la relance des associations qui n'ont pas mit à jour depuis X années
- faciliter la comparaison au modérateur qui approuve
- permettre aux associations de recevoir un email pour récupérer son token (forgotten password)
- je pense : réfléchir à un système classique de compte utilisateurs uniques et personnels pour à la fois les associations et les admins/modérateurs
- permettre la co-modération de la modération avec des notifications multiplexés
- réfléchir à un meilleur SEO
- réfléchir à comment intégrer du contenu utilisateurs
- réfléchir pour permettre aux gens de mettre des articles
- ajouter plus de JSON-ld
- permettre un export JSON facile de tout le contenu (ajouter une meta "alternate" dans le head du site pour linker au JSON)