@alkemio/populator

Enabling society to collaborate. Building a better future, together.

Populate a Alkemio Hub with data from a spreadsheet

This repository has functionality to enable the population of a Challenge Hub with data from a spreadshet. The spreadsheet is a local file, in the "OpenDocument Spreadsheet" (ODS) format.

Spreadsheet Format

The spreadsheet does have a required format. An example of such a sheet is provided in this repo.

If you want to make a custom load of data into an Challenge Hub then please make a copy of this sheet and fill as needed.

Checks steps before starting:

• Ensure that the Alkemio Server is available.

Populating using custom locations or data file:

• Make a copy of .env.default to creat a .env file
• Edit this file to specify the values for the two environment variables:
  • API_ENDPOINT_PRIVATE_GRAPHQL: The server api end point location. This should be the non-interactive private end point.
  • ALKEMIO_DATA_TEMPLATE: The data template to use for population
  • AUTH_ADMIN_EMAIL: The administrator user name for accessing the server. Defaults to [e-mail].
  • AUTH_ADMIN_PASSWORD: The password for the administrator.

Execute the population

Finally you should now be in a position to run the data population!

• Execute npm install - to ensure the dependencies in the project are installed
• Execute npm run populate

Now you can navigate the web client and see a sample populated Challenge Hub - enjoy!

Updating

The populator provides the ability to separately create / update the information on the following entities:

• Organization: execute npm run populate-organizations
• Hub/Challenge/Opportunity: execute npm run populate-context