mgernand / httpstatuses

A directory of HTTP Status Codes and code references

Home Page:https://httpstatuses.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This project is a revival of the now-defunct httpstatuses.com (background)

httpstatuses.io is an easy to reference database of HTTP Status Codes with their definitions and helpful code references, each code is at httpstatuses.io/code. All standard codes are included, as are some non-standard codes that have significant presence in the wild.

Development

App currently builds and runs on Node v12.

Run npm install to pull in dependencies and then node build, a preview will be available at localhost:4887.

Contributing

All contributions are welcome! If you have an idea to improve the website please submit a pull request or create an issue, or provide your thoughts on open issues.

Each status code lives in a Markdown file at contents/codes, the easiest way to submit changes is via the GitHub editor. When contributing changes to the status codes please be mindful of the following:

  • Markdown links should be used as references instead of inline
  • If an RFC or external document is referenced, make the reference a link
  • Source information on a status code from the most recent standards available (Status Code standards directory is available on iana.org)
  • The opening paragraph of a status code should describe the meaning, following paragraphs can describe implementation
  • Don't edit the meaning of descriptions, but formatting and structural changes are a-okay
  • Don't double-space after a period, and remove any examples of it
  • If the description references a section in the current RFC, always add the RFC identifier. For example "Section 6.6" should become "RFC1234 Section 6.6"

About

A directory of HTTP Status Codes and code references

https://httpstatuses.io

License:MIT License


Languages

Language:SCSS 44.4%Language:Pug 28.0%Language:JavaScript 27.6%