Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.75 KB

TOOLS.md

File metadata and controls

66 lines (45 loc) · 1.75 KB

CURRENT TOOLS

Overview

This document is intended as a place to document tools that have been chosen and why they were chosen. If it seems as if there's a better tool then this information can be used to verify that the requirements listed below have been met. If the requirements are not met then there need to be other compelling reasons to displace the existing tool.

Yalc

yalc is an npm module that can be installed globally to easily work with multiple npm modules (in particular atoll core and shared repos). It is also included in each atoll related repo as dev dependency. The sync npm script can be used in atoll-shared to build and publish the latest code for use in atoll-core.

Date Chosen: November 7, 2019

Why It Was Chosen

  • Initially we were using npm link but we ran into a number of problems using it. See ISSUES_RESOLVED.md for more information.

PostgreSQL

PostgreSQL is a good general-purpose SQL database. It is very capable and can even handle document data so you get the best of both worlds (NoSQL and SQL).

See "Getting Started" in README.md for more information about the version to use.

DEPRECATED TOOLS

NPM Link Check

npm-link-check is an npm module that is installed globally to make it easy to determine whether a module has any npm linked modules.

Date Deprecated: November 7, 2019

Why It Was Initially Chosen

  • It works on Windows, Linux and Mac OS X

Why It Was Deprecated

  • After switching to yalc we dropped npm link so this utility was no longer useful.

Alternatives Reviewed

  • link-status - didn't work on Windows