Skip to content
Daniel J. Furman edited this page Oct 21, 2017 · 6 revisions

Welcome to the post-award wiki!

Purpose

This project exists to provide an open source alternative to current entitlement systems used in government and serves as a part of the facet-acq organization to create an entirely open source Procurement-to-Payment alternative to the monoliths currently leveraged in this space.

Contributing

All contributions are welcome! While I can draw on my past experience in these processes and openly available research, my background is heavily on the accounting side so please consider contributing to clarification (grooming) of intent and business value, code, design or any other form!

Norms

In an environment dominated by monoliths, agility is key to the success of this and any facet-acq project. This is the single guiding principle.

Goals/Initial Decisions

  • VueJS for the UI
    • designed as a single page application
    • Bulma.io as a UI framework
    • Web Sockets (avoid polling)
  • Laravel for the application layer/backend
    • Php 7.1+
    • Authorization with JWT
  • PostgreSQL for the database
  • Automated test coverage
  • Git Flow pattern

Guidelines

  • Business logic should be separated into areas of concern so modules can be included as needed. For example, Department of Defense logic should be optional such that it will not conflict or impact General Services Administration logic unless the implementation necessitates.

Getting Started

Business/General

Please open an issue, leave a comment or send me a message if you're interested in playing a role in this project.

Technical

For technical contributors please set up your local environment using Laravel Valet, PostgreSQL 10+ and Redis for caching and session management.

If you're new to Laravel, please consider laracasts education courses. They are an amazing resource on Laravel, Vue and modern coding practices.

If you're not a PHP fan or would prefer to contribute in a different way, please open an issue. The vision of this project is to establish a series of micro-services exchanging information in common defined ways so if you want to do site scraping in python or node or java and contribute that code, please don't be shy! We can certainly use the help.

Clone this wiki locally