Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.56 KB

README.md

File metadata and controls

67 lines (42 loc) · 2.56 KB

AppSignal for Node.js

The AppSignal for Node.js library.

npm (scoped) code style: prettier

Installation

Please follow our installation guide in our documentation. We try to automatically instrument as many packages as possible, but may not always be able to. Make to sure follow any instructions to add manual instrumentation.

Development

Installation

This repository is a mono-managed repository. First install mono on your local machine by following the mono installation steps.

Then install the dependencies and prepare the project for development use using mono:

mono bootstrap

You can then run the following to start the compiler in watch mode.

npm run build:watch --parallel

You can also build the library without watching the directory:

mono build

Version management configuration is provided for asdf.

Testing

The tests for this library use Jest as the test runner. Once you've installed the dependencies, you can run the following command in the root of this repository to run the tests for all packages, or in the directory of a package to run only the tests pertaining to that package:

mono test

Contributing

Thinking of contributing to this repo? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

Also, we would be very happy to send you Stroopwafels. Have look at everyone we send a package to so far on our Stroopwafels page.

Support

Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.