Skip to content

CSPS-EFPC-IT/eWeekly-service

Repository files navigation

E-Briefing Service

This is a Laravel-based backend to the eWeekly App.

Create and manage e-Weekly "binders" that can be installed on a mobile device and updated remotely through the e-Weekly App

This service allows you to:

  • Create a daily itinerary detailing meetings and events and include relevant documents, contacts, and biographies of participants
  • Upload supporting documents and reference materials
  • Create biographies of members of the delegation and people they will meet
  • Free-form "articles" allow you to include any other information that doesn't fit anywhere else
  • Collaborate with other members of your team

Update

This project is forked from CDS and with below modification to meet the need for eWeekly agenda:

  • Allow upload more document types including word, excel, powerpoint and pdf
  • New Secret Key field and allow admin to filter and retrieve the weekly agenda on the iPad
  • New copy week function that allow administrator to copy the whole week from another week block
  • Allow optional title, time from and to when creating an event
  • New drag and drop function inside the event page, and allow admin to re-order the documents' order

Heads up!

This project is still early in development and some of the processes involved in running, installing, and loading data into the app are meant to be temporary work-arounds until more of this functionality can be fleshed out. See more details about this over in the E-Briefing App repository.

See also this TODO list for some of the features we think will be needed for this to be a more complete product.

Running this project

Clone and then install

git clone https://github.com/cds-snc/e-briefing-service.git
cd e-briefing-service
composer install

Setup your environment file and configure your database

The default settings in .env.example should work with the included docker-compose.yml settings. You may need to change these if you're running some other way.

cp .env.example .env

Start the service

You can then bring up a dev environment using the docker-compose file included by running:

docker-compose up

Alternatively, you may want to try Laravel Valet or Laravel Homestead

Migrate and seed the database

php artisan migrate
php artisan db:seed

This will create an Administrator account with the following credentials:

API Key and Remote Sync

For the Remote Sync feature, the E-Briefing App must provide an Authorization token to access the package download route. This token is stored in the users table associated with the main admin user.

Contributing

Please read CONTRIBUTING.md for details on how you can pitch in, and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.


Service de breffage électronique

Il s’agit d’un système principal basé sur Laravel pour l’application de breffage électronique.

Créez et gérez des cartables de breffage électronique qui peuvent être installés sur un appareil mobile et mis à jour à distance au moyen de l’application de breffage électronique.

Ce service vous permet de :

  • créer un itinéraire quotidien détaillant les réunions et les événements en plus d’incorporer les documents, les coordonnés et les biographies des participants pertinents;
  • télécharger des documents en appui et des documents de référence;
  • créer les biographies des membres de la délégation et des personnes qu’ils rencontreront;
  • les « articles » en format libre vous permettent d’inclure tout autre renseignement qui ne peut être placé dans les autres catégories;
  • collaborer avec les autres membres de votre équipe.

Aperçu

Ce projet en est toujours aux premières étapes d’élaboration et certains des processus concernant le fonctionnement, l’installation et le téléchargement de données dans l’application sont des solutions temporaires jusqu’à ce que davantage de fonctions puissent être élaborées. Consultez d’autres renseignements à ce sujet dans le répertoire Application de breffage électronique.

Consultez également cette liste TODO pour connaître certaines caractéristiques qui, selon nous, seront utiles pour que ce produit soit plus complet.

Mise en œuvre de ce projet

Cloner, puis installer

git clone https://github.com/cds-snc/e-briefing-service.git
cd e-briefing-service
composer install

Installez votre fichier environnemental et configurez votre base de données

Les paramètres par défaut dans .env.example devraient fonctionner avec les paramètres docker-compose.yml inclus. Vous pourriez devoir les modifier si vous l’utilisez d’une autre manière.

cp .env.example .env

Démarrez le service

Vous pouvez ensuite installer un environnement de développeur à l’aide du fichier docker-compose inclus en exécutant :

docker-compose up

Sinon, vous pourriez vouloir essayer Laravel Valet ou Laravel Homestead.

Effectuez la migration et remplissez la base de données

php artisan migrate
php artisan db:seed

Cette opération créera un compte d’administrateur ayant les justificatifs d’identité suivants :

Clé API et synchronisation à distance

Pour la synchronisation à distance, l’application de breffage électronique doit fournir un jeton d’autorisation pour accéder à la voie de téléchargement du progiciel. Ce jeton est entreposé dans la tablette users associée à l’utilisateur de l’administration principale.

Contribution

Veuillez lire le document CONTRIBUTING.md pour obtenir des renseignements sur la façon dont vous pouvez contribuer ainsi que sur le processus pour présenter des demandes de déchargement.

Licence

Ce projet utilise la licence MIT – consultez le fichier LICENSE.txt pour obtenir de plus amples renseignements.

About

Backend service for eWeekly app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published