Skip to content

hyperjumptech/monika

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

* feat: upload checksum (#5)

* Feat: Add Pushbullet notification

* Removed unusued file

* Add docs
f81cca7

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
bin
 
 
 
 
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build Status codecov npm-version npm Docker

About

Monika is a command line application for synthetic monitoring. The name Monika stands for "Monitoring Berkala", which means "periodic monitoring" in the Indonesian language.

How to Use

You can find many ways to install Monika and how to start monitoring from the Quick Start page.

Contributing

Monika is a Node.js application written in TypeScript using the oclif framework.
It was developed on node v14 (LTS), and npm v6.

To start developing, clone this repository, then install the dependencies:

git clone git@github.com:hyperjumptech/monika.git
npm ci

Then, to run Monika from the source,

  • on Linux/Unix/Mac
npm start
  • on Windows
.\bin\run.cmd

To keep the formatting consistent, run the following command to format the source code:

npm run format

Finally you can also run npm run test to prevent regression.

Once you have made the changes, open a Pull Request and explain the issue your change will fix or the feature your change will add.

For contribution details on how to add custom notifications see the New Notifications guide here.

Development References

The tools and frameworks we used in this project are listed below:

  • oclif to scaffold the CLI.
  • Prettier to format the code.
  • ESLint to statically analyze the code to quickly find problems.
  • Mocha for testing.
  • Istanbul for code coverage.

Discussions

If you need help, want to give feedback, or have a great idea to improve Monika, get involved! Let us know in the Github discussions.

Please abide by the Contributor's Code of Conduct

Further information

For detailed information, you can click on any of the specific docs below:

Monika - Open source and free HTTP monitoring tool | Product Hunt

License

MIT License.

About

Monika is a command line application to monitor every part of your web app using a simple YAML configuration file. Get alert not only when your site is down but also when it's slow.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published