Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 2.37 KB

README.md

File metadata and controls

68 lines (41 loc) · 2.37 KB
Raw

CoreConX

A simple CFML framework in use with our AutoConX applications.

CoreConX is a standalone CFC or Application extender that provides methods and functionality that we've found helpful in developing the AutoConX Inventory Manager at AutoConX Systems.

Using CoreConX

The latest build of the CoreConX framework lives in the master branch in the dist folder.

Documentation

View the documentation wiki on Github: The CoreConX Wiki

It should document the major features of the framework. If you find something is missing, you can submit a pull request or create an issue on the project.

Example Site

The project comes with an example website. It uses the Application extension technique to show how you'd make your own website with CoreConX.

Dependencies:

To view the example site:

  1. Clone the CoreConX project
  2. Run npm install
  3. Run npm test
  4. Click "Example"

Testing

CoreConX comes with tests. If you want to extend CoreConX and add your own functionality, you are required to provide tests for that functionality. Only if your tests pass (and pass our inspection) will your pull request be accepted.

Dependencies:

To run the tests:

  1. Clone the CoreConX project
  2. Run npm install
  3. Run npm test
  4. Click "CFML" under "Tests"

Contributing

We welcome contributors to code and documentation alike. If you want to help out, here are some considerations:

  1. Use a code editor that supports EditorConfig. This will keep the codebase consistent.
  2. Keep your pull request atomic. The smaller and more focused a pull request is, the more likely it is to be accepted.
  3. Write tests for your new functionality or improve tests for areas where you're fixing bugs.
  4. Add any relevant example code to the Example site.
  5. If your pull request is accepted, you may be asked to update the documentation to explain your functionality.

License

MIT license

Written by Miles Rausch (@awayken)