mjain61/vulnsearch

A web application for local searching of CVE data.

vulnsearch

A fast, well-behaved replacement for other CVE search tools.

System requirements

• Crystal ~> 0.20
• Shards ~> 0.7
• libsqlite3 ~> 3.16
• GNU Make

Getting started

# Install dependencies, migrate database, compile application
# Use `make help` to get information about available make targets
$ make

# Download `.xml` CVE data from NVD
$ bin/vulnsearch --fetch

# Load CVE data from `.xml` files into database with indexing; ~15 minutes.
$ bin/vulnsearch --load

# Run web application
# Visit http://localhost:3000/ in your browser!
$ bin/vulnsearch

Usage

TBD...

Credits

"Protection" icon by Chanut is Industries, licensed under CC BY 3.0 US.

Contributing

1. Fork it ( https://github.com/t-richards/vulnsearch/fork )
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