uneca/dissemination-toolkit

Census and survey data dissemination tool

1.1.2 2024-11-14 13:06 UTC

Requires

• php: ^8.2
• laravel/jetstream: ^5.3
• livewire/livewire: ^3.4
• spatie/laravel-package-tools: ^1.16
• spatie/laravel-translatable: ^6.8

Requires (Dev)

• nunomaduro/collision: ^8.1.1||^7.10.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3

MIT

• UNECA

• laravel
• uneca
• dissemination-toolkit

README

As the dissemination toolkit is built for Laravel, you will first have to create a fresh Laravel project.

Please refer to the Laravel documentation here on how to go about this.

Here is the TLDR version of a Laravel project creation

After you have installed PHP and Composer, you may create a new Laravel project via the Composer create-project command:

composer create-project laravel/laravel my-dissemination

Once you have created the project, you may use composer to install the latest version of the toolkit into your new Laravel project:

composer require uneca/dissemination-toolkit

After installing the package, you may execute the dissemination:install artisan command. This command will install a suite of tools and features that enable you to build a modern census/data dissemination platform.

php artisan dissemination:install

New Applications Only

Dissemination toolkit should only be installed into new Laravel applications. Attempting to install it into an existing (modified or not freshly installed) Laravel application will result in unexpected behavior and issues.

Now that you have scaffolded your dissemination platform, the next step is to edit your application's .env configuration file and put in the correct settings for your database and other relevant settings.

To proceed, you need to first create a PostgreSQL database and add the details to the .env file (see below). Again please refer to the Laravel documentation on how to configure a database connection.

DB_CONNECTION=pgsql
DB_HOST=your database host name or ip address
DB_PORT=your database port (5432 is the default port for postgres)
DB_DATABASE=your database name
DB_USERNAME=your database username
DB_PASSWORD=your database password

For a complete list of all environment variables you can configure, please refer to the relevant section of the documentation.

Once you have edited your .env file, you are now ready to run the database migrations:

php artisan migrate

At this point, you are ready to start your server, whatever that may be (artisan serve command, nginx, WAMP, IIS, etc.) and navigate to the web address where you will see the landing page

The quickest way would be to run the built-in artisan web server like so,

php artisan serve

Assuming everything goes well, you should be able to navigate to http://localhost:8000 and see the landing page

Finally, you can run the adminify command to create a Manager account with which you can access your new platform.

php artisan adminify

Configuration

The first thing you should probably set the details for is your organization.

You can do this by going to the management drop down and then to the "Organization" menu

Then you should create your area hierarchy and import your areas

Next, you should populate some data for your:

• Topics
• Indicators
• Dimensions
• Dimension values
• Documents and
• Datasets

Finally, you can move onto creating visualizations and data stories