An open API service indexing awesome lists of open source software.

https://github.com/ytti/oxidized-web

Web UI + RESTful API for Oxidized
https://github.com/ytti/oxidized-web

Last synced: 5 months ago
JSON representation

Web UI + RESTful API for Oxidized

Awesome Lists containing this project

README

          

# Oxidized Web

[![Build Status](https://github.com/ytti/oxidized-web/actions/workflows/ruby.yml/badge.svg)](https://github.com/ytti/oxidized-web/actions/workflows/ruby.yml)
[![Gem Version](https://badge.fury.io/rb/oxidized-web.svg)](http://badge.fury.io/rb/oxidized-web)

Web user interface and RESTful API for Oxidized.

## Installation
This is not useful independently, see https://github.com/ytti/oxidized for
install instructions.

Note: because of its dependencies, installing the `oxidized-web` gem will
install `oxidized` automatically.

## Configuration
`oxidized-web` is configured through the configuration of `oxidized`,
in the `extension` section. For details, see
[docs/configuration.md](docs/configuration.md).

## Development
If you wonder how to run oxidized-web from git for development, have a look at
[docs/development.md](docs/development.md).

## License and Copyright
Copyright 2013-2015 Saku Ytti
2013-2015 Samer Abdel-Hafez

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.