Enabling society to collaborate. Building a better future, together.
This repository helps get a simple demonstrator instance of Alkemio running, and populated.
This repository is seriously out of date. If you are interested in creating a local instance of Alkemio then please reach out (support@alkem.io) or look to the Server repository, together with the Populator repository
The core pieces of the demo are:
As shown by the bold arrows on the above diagram, you can then intereact in two primary ways with the demo:
Prerequisites:
git clone https://github.com/alkem-io/Demo.git
)The following commands are used to run this project:
sudo .scripts/bootstrap.sh
.npm run start:demo
Note: the first time the cluster starts up it has some installations to make, so it may take up to 5 minutes before the Alkemio Server is running. To monitor how the containers are starting up either use a tool like Docker Desktop (windows) or Portainer (any operating system).
At this point you hopefully will have a running platform with a default Space! Both client and server are exposed locally and can be accessed as per description above.
Once the cluster is setup, the next step is to load data into the Alkemio Server:
npm install
@lk3m10!
. The user has global admin permissions and is required for the data population.npm run sample-data
..env.docker
file to be .env
file) and add AUTH_ADMIN_EMAIL=[email] and / or AUTH_ADMIN_PASSWORD=[password]At this point you hopefully have a populated Hub, with a sample Space / sample users visible.
The default administrator login is admin@alkem.io. If you register using that email address you will be able to explore the adminstration capabilities of the platform.
If you are interested in seeing the data that is held within the Alkemio platform, then it is advisable to try out directly querying data from the GraphQL api.
For this, open a local browser and navigate to http://localhost:3000/graphql.
A simple graphql query to try out is:
query {
spaces {
id
profile {
displayName
tagline
},
subspaces {
profile {
displayName
}
}
}
}
Full details of the api can be found on the docs and schema tabs on the right hand side:
The sample data that is loaded is from the alkemio-sample-sdgs.ods
file in this repository. This is a spreadsheet, that can be opened in Excel or compatible tools.
To modify the data and see how Alkemio could be used for hosting your collaboration spaces, you can get a first impression by modifying this file.
Note: this file is using an old format, please see the latest vversion of the Populator for latest format.
Note: the file to be loaded is specfied by the ALKEMIO_DATA_TEMPLATE environment variable. This is set in the .env
that you created above, so you can also specify a different file name by editing this environment variable.