gitter-badger / listo Goto Github PK

Use questionnaires and checklists to make it easy to do the right thing, regarding the software you build.

Checklists are at the heart of Listo, empowering engineering teams to perform a web-based self-assessment, which results in a Trello board containing the essential security, reliability and architecture requirements from our RFCs, tailored to a project's objectives.

A more detailed blog post can be found on SEEK's Tech Blog.

The quickest way to get Listo running locally is to launch it via Docker Compose.

1. Install Docker and Docker Compose (Mac users can install both here).
2. Create an env.sh file in the root directory:

# Get your API Key here -> https://trello.com/app-key/
export TRELLO_API_KEY=e94947...00a92

# Click on the "Generate a Token" link here -> https://trello.com/app-key/.
export TRELLO_TOKEN=fda876d8af87d6fa876adfa....8516dcf715

3. Start the Listo service (server and UI) and local DynamoDB database:

$ make serve

4. [OPTIONAL] Once you have Listo running locally you can now customise the checklists and questions for your own requirements here.

If you want to modify or debug Listo's code, it's often easier without using Docker or Docker Compose.

Listo requires Yarn and Docker (only for the local Dynamo db).

Note you will still need to have the env.sh configured as per Getting Listo Running Locally.

In the server directory:

1. Start the DynamoDB local Docker instance:

$ make start_db

2. Start the server by running:

$ make serve

See the Makefile for more options.

In the frontend directory:

1. Run the following to launch the UI:

$ make serve

See the Makefile for more options.

2. The browser should auto open, if not you can navigate to:

http://localhost:3000/

Deploying Listo for production use requires an AWS account with access to a DynamoDB Table. However, we plan to support other DB's in the future to remove the AWS requirement.

We have a separate build repo internally that picks up this repo and deploys Listo internally with a separate set of custom questions and checklists. We add authentication (using an internal service) and use AWS Secret's Manager for storing credentials). An example of our build process can be found here.

• Sample questions and checklists can be found in the data directory.
• Listo was influenced by goSDL.

MIT.