Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
144 lines (93 loc) · 3.13 KB

DEVELOPMENT.md

File metadata and controls

144 lines (93 loc) · 3.13 KB

Developing StoryMapJS - the javascript

When you make changes to the code, you should execute the build command. To test your changes, run a simple local web server in the project root and navigate, e.g. to http://localhost:8000/src/template/index.html.

Install the dependencies and build the javascript:

 $ npm install
 $ npx webpack -c webpack.dev.js

StoryMap editor development

Questions not yet completely addressed with the new localstack based setup:

Note:

Built static is served directly (via the flask app) from the compiled directory, but the current development setup does not sort this out very well. Unless you have a need to host the static code locally, the easiest thing to do is probably to point to a deployed cdn. ie., set this env variable:

   CDN_URL=https://cdn.knightlab.com/libs/storymapjs/latest/

Overview / tl;dr

To get started you will need to do the following steps which are described in more detail below:

  • install docker-compose
  • install the aws cli
  • build and import ssl certs
  • create a .env file
  • docker-compose build and up
  • create the s3 buckets in localstack
  • create the users table in postgres

Getting started developing StoryMap with docker-compose

Install docker-compose

Be sure to have Docker and (docker-compose)[https://docs.docker.com/compose/] installed.

Build ssl certs for localstack

Localstack would automatically create ssl certs, but without authority, thus making the stack inaccesible via the browser. Instead, we generate a certificate chain with authority using the server.test filenames that localstack expects.

This should be done before bringing up the stack so that localstack will use the generated cert.

Execute the following from the repo root:

 $ scripts/makecerts.sh

Import the web cert to your browser

Note: If you want to view a share link, ie. a StoryMap directly from the localstack hosted s3, you can do it via http rather than https. The backend calls to localstack should still work without this import.

Note: on Mac, hit CMD+SHIFT+. to see dotted files in the finder.

  • For Firefox:
    • Preferences >
    • Certificates >
    • View Certificates >
    • Your Certificates >
    • Import .localstack/KnightLabRootCA.pem

Create a .env file

 $ cp dotenv.example .env

Fill in the missing keys and other secret info. The following are required:

Needed to login to StoryMap:

  • GOOGLE_CLIENT_ID
  • GOOGLE_CLIENT_SECRET

Run the development docker-compose stack

 $ docker-compose build
 $ docker-compose up

Create the s3 buckets

After the services come up, create the required buckets:

 $ scripts/makebuckets.sh

Create the users table

 $ scripts/create-tables.sh

Open application

Navigate to https://localhost and accept the self-signed certificate.

Docker troubleshooting

Some commands to know:

 $ docker-compose images
 $ docker-compose up --remove-orphans
 $ docker ps
 $ docker stop
 $ docker system prune
 $ docker volume ls
 $ docker volume rm

Also, specific to localstack:

 $ aws --debug --endpoint-url=https://localhost:4566 s3 ls