Skip to content

Commit

Permalink
add some missing information to the hacking instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Jamie Jackson committed Feb 13, 2025
1 parent 0e14f56 commit e430d70
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,27 @@ The code in this library has only been tested on Lucee and likely doesn't work o

## Extending this module/service

Individuals who would like to contribute to this library can follow the steps below to configure this tool to run independently for the purposes of extending and testing the code:

1. This package currently depends on a `cfconfig.local` host entry. You can add this to your system's `hosts` file manually or leverage a tool like [Commandbox HostUpdater](https://www.forgebox.io/view/commandbox-hostupdater) to add the host entry.
2. Start up this project with CommandBox using `server start` - this will open a browser to the test runner for this project.
3. Happy Contributing!
Individuals who would like to contribute to this library can follow the steps below to configure this tool to run independently for the purposes of extending and testing the code.

Happy contributing!

### Prerequisites

* This package depends on a `cfconfig.local` host entry. You can add this to your system's `hosts` file manually or leverage a tool like [Commandbox HostUpdater](https://www.forgebox.io/view/commandbox-hostupdater) to add the host entry.
* Manual
* Hosts File Location
* Windows: `C:\Windows\System32\drivers\etc\hosts`
* Mac/Linux: `/etc/hosts`
* Add the following line to the file:
```
127.0.0.1 cfconfig.local
```
* Install [CommandBox](https://www.ortussolutions.com/products/commandbox)
* Install dependencies
```
box install
```
### Run Tests
Start up this project with CommandBox using `box server start` - this will open a browser to the test runner for this project.

0 comments on commit e430d70

Please sign in to comment.