Skip to content

Latest commit

 

History

History
56 lines (28 loc) · 1.77 KB

README.md

File metadata and controls

56 lines (28 loc) · 1.77 KB
Raw

Audit

Audit is a Rails application that allows users to check for vulnerabilities in their Gemfiles in an efficient and secure manner.

You can see it working in https://audit.fastruby.io

Requirements

  • Ruby version 2.7.2
  • Node version greater than 8.16.0
  • Yarn (npm install --global yarn)

Getting started

./bin/setup

Start the server

rails server

You should be able to go to http://localhost:3000 and see the landing page.

Running tests

rails spec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fastruby/audit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

When Submitting a Pull Request:

  • If your PR closes any open GitHub issues, please include Closes #XXXX in your comment

  • Please include a summary of the change and which issue is fixed or which feature is introduced.

  • If changes to the behavior are made, clearly describe what changes.

  • If changes to the UI are made, please include screenshots of the before and after.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Audit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Sponsorship

FastRuby.io | Rails Upgrade Services

Audit is maintained and funded by FastRuby.io. The names and logos for FastRuby.io are trademarks of The Lean Software Boutique LLC.