This repository has been archived by the owner. It is now read-only.
The EPA e-Manifest project
Ruby HTML CSS JavaScript Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
doc
lib
public
script
spec
tours
.cfignore
.codeclimate.yml
.env.example
.env.test
.gitignore
.rspec
.ruby-version
.travis.yml
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE.md
Procfile
README.md
Rakefile
config.ru
e-manifest-dev.manifest.yml
e-manifest.manifest.yml

README.md

The e-Manifest App for EPA

View the live application »

Build Status Code Climate

Application architecture

This is a Rails application with a Postgres database containing both API endpoints and web views. The API is a JSON REST API. The web app and the API use the same database.

We use Elasticsearch to search for manifest records. Elasticsearch offloads read-access from the database and provides full-text search capabilities painful to apply directly to a database.

Redis is used for Sidekiq job processing. The Redis + Sidekiq solution offloads the database/Elasticsearch syncing to an async process.

Developer onboarding

Here are some tips and resources for getting started on this project. Note not all resources are available to people outside of the EPA / 18F for security reasons.

  • Join the #c-epa-emanifest and #e-manifest-partners channels in the 18F Slack organization.
  • Ask in Slack for the Vendor Onboarding document for background on the problem space.
  • Read the project brief.
  • Make sure you're added to the Trello board.
  • Set up the app using the instructions in CONTRIBUTING.md.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.