Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add some missing information to the hacking instructions #61

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.