https://github.com/inacior/is-my-env-alive
This is a simple project that helps you to check - easily and quickly - if all your APIs or Frontends are online!
https://github.com/inacior/is-my-env-alive
cli hacktoberfest javascript nodejs npm
Last synced: over 1 year ago
JSON representation
This is a simple project that helps you to check - easily and quickly - if all your APIs or Frontends are online!
- Host: GitHub
- URL: https://github.com/inacior/is-my-env-alive
- Owner: inacior
- License: gpl-3.0
- Created: 2020-09-29T22:19:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-25T20:36:00.000Z (about 5 years ago)
- Last Synced: 2025-03-14T02:04:10.391Z (over 1 year ago)
- Topics: cli, hacktoberfest, javascript, nodejs, npm
- Language: JavaScript
- Homepage:
- Size: 1.42 MB
- Stars: 2
- Watchers: 0
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Is my environment alive?
======================
:star: Star us on GitHub — it helps!
[is-my-env-alive](https://to-do-link) is a simple project that helps you to check - easily and quickly - if all your APIs or Frontends are online!
## Table of content
- [Installation](#installation)
- [Usage](#usage)
- [JSON Structure](#json-structure)
- [License](#license)
- [Links](#links)
## Installation
Install the package
```bash
npm i -g is-my-env-alive
```
Create a JSOn file to define your projects
```bash
touch projects.json
vi projects.json
```
Insert your environments and projects
```json
{
"stage": {
"products-api": {
"url": "https://stage.my-awesome-api/products/search?limit=1",
"status": 200
},
"categories-api": {
"url": "https://stage.my-awesome-api/categories/search?limit=1",
"status": 200
}
},
"develop": {
"products-api": {
"url": "https://develop.my-awesome-api/products/search?limit=1",
"status": 200
},
"categories-api": {
"url": "https://develop.my-awesome-api/categories/search?limit=1",
"status": 200
}
}
}
```
## Usage
```bash
is-my-env-alive -e stage -f projects.json
```
## JSON Structure
`url` \
Endpoint that will be pointed out in the request to validate whether the API is online or not
`status` \
Expected _url_ status to define that the API is online
## License
The [is-my-env-alive](https://to-do-link) extension is licensed under the terms of the GPL Open Source
license and is available for free.
## Links
* [Source code](https://github.com/inacior/is-my-env-alive)