https://github.com/getspooky/express-telescope

🚀 A beautiful error page for NodeJS apps 🔭🔭🔭
https://github.com/getspooky/express-telescope

errors exception-handling expressjs expressjs-apps nodejs page telescope ui

Last synced: 4 months ago
JSON representation

🚀 A beautiful error page for NodeJS apps 🔭🔭🔭

• Host: GitHub
• URL: https://github.com/getspooky/express-telescope
• Owner: getspooky
• License: mit
• Created: 2019-12-15T20:47:27.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-23T21:52:15.000Z (about 5 years ago)
• Last Synced: 2024-04-14T18:56:08.327Z (10 months ago)
• Topics: errors, exception-handling, expressjs, expressjs-apps, nodejs, page, telescope, ui
• Language: TypeScript
• Homepage:
• Size: 291 KB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
##  Telescope: A beautiful error page for Expressjs apps

[Telescope]() is a beautiful and customizable error page for expressjs applications for both development and production mode.

Feel free to check out the [changelog](/CHANGELOG.md), [security policy](.github/SECURITY.md), [license](LICENSE.md), [commit convention](.github/COMMIT_CONVENTION.md).

[![Build Status](https://travis-ci.com/getspooky/express-telescope.svg?branch=master)](https://travis-ci.com/getspooky/express-telescope)

![npm](https://img.shields.io/npm/dw/express-telescope)

![solution](docs/screenshot.png)

## Requirements

Telescope has a few requirements you should be aware of before installing:

- Node.js >= 8.0.0

- npm >= 6.10.3

## Installation

[![NPM](https://nodei.co/npm/express-telescope.png)](https://nodei.co/npm/express-telescope/)

This is a Node.js module available through the npm registry.

Installation is done using the [npm install command](https://docs.npmjs.com/downloading-and-installing-packages-locally):


 npm install express-telescope --save-dev



## Browser Support

Telescope supports reasonably recent versions of the following browsers:

- Google Chrome

- Apple Safari

- Microsoft Edge

## Examples

To view the examples, clone the Express repo and install the dependencies:


$ git clone https://github.com/getspooky/telescope.git

$ cd telescope

$ npm install



Then run whichever example you want:


$ npm run example



## Security Vulnerabilities

If you discover a security vulnerability within Telescope, please send an e-mail to Yasser Ameur El Idrissi via `[email protected]` . All security vulnerabilities will be promptly addressed.

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## How Can I Help?

- Contribute to the core repository.

- Ask your employer to use Telescope in projects.

- Make a tutorial that you explain Telescope.

- Follow our Telescope repository.

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.