Skip to content

flexion/ef-cms

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Electronic Filing / Case Management System

An as-yet-unnamed project by the U.S. Tax Court, creating an open-source EF-CMS. Work began in October 2018, and can be seen in the staging branch. For background, see the RFQ to procure agile software development services.

Building Everything

If you'd like to run the same checks that run in Jenkins (except Sonarqube at the moment...) locally using docker containers, run the following:

./build-all.sh

This will run the lint, shellcheck, audit, build, test, cypress, cerebral tests, pa11y, etc over all the components.

Running / Verifing the Project via Docker

Assuming you have Docker installed, The following command will spin up a docker container with the UI, API, local S3, local Dynamo, etc all running inside it:

./docker-run.sh

You can access the UI at http://localhost:1234 You can access the API at http://localhost:3000 You can access the dynamodb shell at http://localhost:8000/shell You can access the dynamodb-admin ui at http://localhost:8001 You can access s3 local at http://localhost:9000

In order to kill that docker container, you will need to run the following command in separate terminal:

./kill-docker-run.sh

Running this project locally without Docker

The EF-CMS is comprised of two components: the API and the UI. Each must be run in order to function.

Prerequisites

  • node v8.10.0
  • npm 6.4.1

Setup

Both the web-client and efcms-service share code that exists in the business directory; therefore, before you can run either, you need to run an npm install inside the business directory.

  • cd business && npm i
  • cd ../web-client && npm i
  • cd ../efcms-service && npm i

Terminal A

  • cd web-client && npm start

Terminal B

  • cd efcms-service && npm start

CI/CD Setup

Please look at the SETUP.md.

Editor configuration

Atom.io

Install the following for best results:

Contributing

See CONTRIBUTING for additional information.

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.

About

An Electronic Filing / Case Management System.

Resources

Stars

Watchers

Forks

Packages

No packages published