Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crystal-loot/exception_page
An exceptional exception page for Crystal web libraries and frameworks
https://github.com/crystal-loot/exception_page
crystal hacktoberfest web
Last synced: 28 days ago
JSON representation
An exceptional exception page for Crystal web libraries and frameworks
- Host: GitHub
- URL: https://github.com/crystal-loot/exception_page
- Owner: crystal-loot
- License: mit
- Created: 2018-06-29T13:16:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-13T21:47:19.000Z (about 2 months ago)
- Last Synced: 2024-11-07T13:25:36.485Z (about 1 month ago)
- Topics: crystal, hacktoberfest, web
- Language: HTML
- Homepage:
- Size: 98.6 KB
- Stars: 64
- Watchers: 7
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - Exception Page - An exceptional exception page for Crystal web libraries and frameworks (Framework Components)
- awesome-crystal - Exception Page - An exceptional exception page for Crystal web libraries and frameworks (Framework Components)
- awesome-crystal - Exception Page - An exceptional exception page for Crystal web libraries and frameworks (Framework Components)
README
# Exception Page [](https://github.com/crystal-loot/exception_page/actions/workflows/ci.yml)
A library for displaying exceptional exception pages for easier debugging.
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
exception_page:
github: crystal-loot/exception_page
```
## Usage
Require the shard:
```crystal
require "exception_page"
```
Create an exception page:
```crystal
class MyApp::ExceptionPage < ExceptionPage
def styles : Styles
ExceptionPage::Styles.new(
accent: "purple", # Choose the HTML color value. Can be hex
)
end
end
```
Render the HTML when an exception occurs:
```crystal
class MyErrorHandler
include HTTP::Handler
def call_next(context)
begin
# Normally you'd call some code to handle the request
# We're hard-coding an error here to show you how to use the lib.
raise SomeError.new("Something went wrong")
rescue e
context.response.status_code = 500
context.response.print MyApp::ExceptionPage.new context, e
end
end
```
## Customizing the page
```crystal
class MyApp::ExceptionPage < ExceptionPage
def styles : Styles
ExceptionPage::Styles.new(
accent: "purple", # Required
highlight: "gray", # Optional
flash_highlight: "red", # Optional
logo_uri: "base64_encoded_data_uri" # Optional. Defaults to Crystal logo. Generate a logo here: https://dopiaza.org/tools/datauri/index.php
)
end
# Optional. If provided, clicking the logo will open this page
def project_url
"https://myproject.com"
end
# Optional
def stack_trace_heading_html
<<-HTML
Say hi
HTML
end
# Optional
def extra_javascript
<<-JAVASCRIPT
window.sayHi = function() {
alert("Say Hi!");
}
JAVASCRIPT
end
end
```
## Development
TODO: Write development instructions here
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [@paulcsmith](https://github.com/paulcsmith) Paul Smith
- [@faustinoaq](https://github.com/faustinoaq) Faustino Aigular - Wrote the initial [Amber PR adding exception pages](https://github.com/amberframework/amber/pull/864)
- [@Sija](https://github.com/paulcsmith) Sijawusz Pur Rahnama
## Special Thanks
This exception page is heavily based on the [Phoenix error page](https://github.com/phoenixframework/phoenix/issues/1776)
by [@rstacruz](https://github.com/rstacruz). Thanks to the Phoenix team and @rstacruz!