Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ponsfrilus/botonews
https://github.com/ponsfrilus/botonews
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ponsfrilus/botonews
- Owner: ponsfrilus
- License: mit
- Created: 2021-09-13T08:11:22.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-04T13:59:25.000Z (over 2 years ago)
- Last Synced: 2023-04-28T14:39:06.916Z (over 1 year ago)
- Language: TypeScript
- Size: 392 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botonews
Botonews a pour but de fournir une plateforme de distribution de news, à partir de différentes sources à destination de différents supports, en fonction des préférences de l'utilisateur. Botonews permet de recevoir les informations souhaitées sur différents supports comme [Discord](https://discord.com), [Telegram](https://telegram.org) ou encore par e-mail.
## Table des matières
- [Comment installer Botonews](#comment-installer-botonews)
- [Terminologie](#terminologie)
- [Technologies](#technologies)
- [Contributeurs](#contributeurs)
## Comment installer Botonews
1. Cloner le repo avec [Git](https://git-scm.com/) : `git clone [email protected]:Azecko/botonews.git`
2. Se déplacer dans le répertoire : `cd botonews`
3. Renommer `sample.env-auth` et `sample.env-db` en `.env-auth` et `.env-db` et y remplacer les données avec vos données.
4. Démarrer les conteneurs grâce à la commande : `docker-compose up`
5. Se rendre sur https://localhost:8081/login et profiter ! :)
*En cas de problème, [ouvrir une issue](https://github.com/Azecko/botonews/issues/new)*
## Terminologie
- **Sources** : Une source est une source d'information, par exemple : NewYorkTimes, LeTemps, 20minutes, etc.
- **Supports** : Un support permet de recevoir les informations souhaitées, par exemple : Discord, Telegram, e-mails, etc.
- **Subscriptions** : Une subscription est un abonnement relié entre un utilisateur, un support, et une ou plusieurs source(s). Un abonnement peut aussi contenir des modalités, comme une heure et des jours. Exemple : L'utilisateur Azecko souhaite recevoir les nouveaux articles du NewYorkTimes et du 20minutes tous les Samedis à 18h sur Discord.
## Technologies
- [Bootstrap](https://getbootstrap.com/)
- [EJS](https://ejs.co/)
- [ExpressJS](https://expressjs.com/fr/)
- [Gravatar](https://en.gravatar.com)
- [MySQL](https://www.mysql.com/fr/)
- [MySQL2](https://www.npmjs.com/package/mysql2)
- [PassportJS](https://www.passportjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
## Contributeurs
