Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.24 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.24 KB
Raw

OpenMappr Player 📊

Prerequisites

  • node > v14
  • install npm dependencies npm install

Run the project

To run the project locally, run the following command:

npm run start

It would use the sample TED data to be used as a source of the data for the project.

If you want to replace the data with your own, place the data into the data folder. The easiest way to generate the data it is to use the Py2Mappr tool.

Publish the project

In order to publish the project to the S3 bucket, the AWS credentials must be configured.

All the configuration is stored in the .env file. In order to run the project, you need to create the .env file and place the following variables inside it:

AWS_ACCESS_KEY=
AWS_SECRET_KEY=
BUCKET=
CLOUDFLARE_API_KEY=

If it is required to purge the Cloudflare Cache after the deployment, the API key for Cloudflare must be provided, otherwise, this field can be left empty.

Once it is configured, the following command will generate all the assets and publish them to the S3 bucket:

npm run publish

To have only the static files generated, set NODE_ENV to be production and run the build command:

NODE_ENV=production npm run build