Skip to content
Merged
Show file tree
Hide file tree
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
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ In this [Beginner Tutorial: Hello World][2], we'll be writing a simple applicati

**CFML Engines:**

- Adobe ColdFusion 2018/2021/2023
- Lucee 5/6/7
- Boxlang 1
- **Adobe ColdFusion**: 2018, 2021, 2023
- **Lucee**: 5.x, 6.x, 7.x
- **BoxLang**: 1.x

**Supported Databases:**

Expand Down Expand Up @@ -117,7 +117,8 @@ Please report any errors you encounter on our [issue tracker][4]. When reporting

## Supported CFML Engines

CFWheels supports the following CFML engines:
Wheels supports the following CFML engines:

- **Adobe ColdFusion**: 2018, 2021, 2023
- **Lucee**: 5.x, 6.x, 7.x
- **BoxLang**: 1.x
Expand All @@ -140,5 +141,5 @@ Made with [contrib.rocks](https://contrib.rocks).

[1]: https://wheels.dev/
[2]: https://wheels.dev/3.0.0/guides/introduction/readme/beginner-tutorial-hello-world
[3]: https://github.com/wheels-dev/wheels/blob/main/CONTRIBUTING.md
[3]: ./CONTRIBUTING.md
[4]: https://github.com/wheels-dev/wheels/issues
28 changes: 14 additions & 14 deletions docs/src/introduction/readme/boxlang-support.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# BoxLang Server Setup

CFWheels supports BoxLang 1.x, providing developers with a modern, high-performance CFML runtime. You can run BoxLang applications using either CommandBox or BoxLang Mini-Server.
Wheels supports BoxLang 1.x, providing developers with a modern, high-performance CFML runtime. You can run BoxLang applications using either CommandBox or BoxLang Mini-Server.

## Prerequisites

- **Java 21 or higher** installed on your system
- **CFWheels application** (generated or existing)
- **Wheels application** (generated or existing)
- **BoxLang runtime** (see installation options below)

## Method 1: Using CommandBox (Recommended)

CommandBox provides the easiest and most feature-rich way to run BoxLang applications with CFWheels.
CommandBox provides the easiest and most feature-rich way to run BoxLang applications with Wheels.

### Installation and Setup

Expand All @@ -27,7 +27,7 @@ box server start cfengine=boxlang@1.4.0+40

### BoxLang Module Dependencies

BoxLang requires specific modules for full CFWheels compatibility. These core dependencies should be added to your `box.json` file:
BoxLang requires specific modules for full Wheels compatibility. These dependencies should be added to your `box.json` file:

```json
{
Expand Down Expand Up @@ -65,7 +65,7 @@ box install bx-mysql

#### Additional Database Support

For other databases supported by CFWheels, install the corresponding BoxLang modules:
For other databases supported by Wheels, install the corresponding BoxLang modules:

- **Microsoft SQL Server**: `box install bx-mssql`
- **PostGreSQL Server**: `box install bx-postgresql`
Expand Down Expand Up @@ -128,7 +128,7 @@ BoxLang Mini-Server provides a lightweight, standalone option perfect for minima

### Installation

BoxLang Mini-Server can be downloaded directly from the official BoxLang releases. The latest version is fully compatible with CFWheels.
BoxLang Mini-Server can be downloaded directly from the official BoxLang releases. The latest version is fully compatible with Wheels.

**Download the latest BoxLang Mini-Server:**

Expand Down Expand Up @@ -158,7 +158,7 @@ curl -LO https://downloads.ortussolutions.com/ortussolutions/boxlang-runtimes/bo
│ ├── stylesheets/
│ ├── javascripts/
│ └── images/
└── vendor/wheels/ # CFWheels framework files
└── vendor/wheels/ # Wheels framework files
```

3. **Setup BoxLang Entry Point**
Expand All @@ -167,7 +167,7 @@ curl -LO https://downloads.ortussolutions.com/ortussolutions/boxlang-runtimes/bo

```boxlang
<bx:script>
// BoxLang rewrite handler for CFWheels
// BoxLang rewrite handler for Wheels
// This file handles URL rewriting for BoxLang compatibility

// Get the requested URI
Expand Down Expand Up @@ -256,11 +256,11 @@ curl -LO https://downloads.ortussolutions.com/ortussolutions/boxlang-runtimes/bo
}
</bx:script>

<!--- Include the main CFWheels bootstrap file --->
<!--- Include the main Wheels bootstrap file --->
<bx:include template="index.cfm" />
```

This file serves as the BoxLang-specific entry point that handles URL rewriting and bootstraps your CFWheels application.
This file serves as the BoxLang-specific entry point that handles URL rewriting and bootstraps your Wheels application.

### Starting BoxLang Mini-Server

Expand All @@ -283,9 +283,9 @@ java -jar /path/to/boxlang-miniserver-1.4.0.jar \
--debug
```

#### For CFWheels Template Structure
#### For Wheels Template Structure

If using the CFWheels base template structure:
If using the Wheels base template structure:

```bash
java -jar /path/to/boxlang-miniserver-1.4.0.jar \
Expand All @@ -301,7 +301,7 @@ java -jar /path/to/boxlang-miniserver-1.4.0.jar \
| `--webroot` | Document root directory (required) | None |
| `--host` | IP address to bind to | 0.0.0.0 |
| `--port` | Port number | 8080 |
| `--rewrite` | Enable URL rewriting (recommended for CFWheels) | false |
| `--rewrite` | Enable URL rewriting (recommended for Wheels) | false |
| `--debug` | Enable debug mode | false |
| `--config` | Path to configuration file | None |
| `--libs` | Additional library paths | None |
Expand Down Expand Up @@ -339,7 +339,7 @@ You can read the further details from the boxlang mini-server documentation
# Verify server is responding
curl http://localhost:8080

# Test CFWheels is loading
# Test Wheels is loading
curl http://localhost:8080/wheels

# Check specific routes
Expand Down
2 changes: 1 addition & 1 deletion docs/src/introduction/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ app/controllers/
app/global/
app/migrator/
app/models/
app/plugins/
app/views/
plugins/
```

#### 2.2 Configurations
Expand Down
2 changes: 1 addition & 1 deletion docs/src/plugins/developing-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Finally, there is a way to specify that your plugin needs another plugin install

### Making Plugin Development More Convenient with Wheels Settings

When your Wheels application first initializes, it will unzip and cache the zip files in the `/app/plugins` folder. Each plugin then has its own expanded subfolder. If a subfolder exists but has no corresponding zip file, Wheels will delete the folder and its contents.
When your Wheels application first initializes, it will unzip and cache the zip files in the `/plugins` folder. Each plugin then has its own expanded subfolder. If a subfolder exists but has no corresponding zip file, Wheels will delete the folder and its contents.

This is convenient when you're deploying plugins but can be annoying when you're developing your own plugins. By default, every time you make a change to your plugin, you need to rezip your plugin files and reload the Wheels application by adding `?reload=true` to the URL.

Expand Down
6 changes: 3 additions & 3 deletions docs/src/plugins/installing-and-using-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ By using plugins created by the community or yourself, you're able to add brand

### Manually Installing and Uninstalling Plugins

This couldn't be any simpler. To install a plugin, just download the plugin's `zip` file and drop it in the `/app/plugins` folder.
This couldn't be any simpler. To install a plugin, just download the plugin's `zip` file and drop it in the `/plugins` folder.

If you want to remove it later simply delete the `zip` file. (Wheels will clean up any leftover folders and files.)

Expand Down Expand Up @@ -41,11 +41,11 @@ $ install select-string
```
{% endcode %}

When run in the root of a Wheels application, it should automatically add the plugin to `/app/plugins` and generate a `.zip` file with the corresponding name and version number.
When run in the root of a Wheels application, it should automatically add the plugin to `/plugins` and generate a `.zip` file with the corresponding name and version number.

### File Permissions on plugins Folder

You may need to change access permissions on your application's `/app/plugins` folder so that Wheels can write the subfolders and files that it needs to run. If you get an error when testing out a plugin, you may need to loosen up the permission level.
You may need to change access permissions on your application's `/plugins` folder so that Wheels can write the subfolders and files that it needs to run. If you get an error when testing out a plugin, you may need to loosen up the permission level.

### Plugin Naming, Versioning, and Dependencies

Expand Down
10 changes: 5 additions & 5 deletions docs/src/plugins/publishing-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ In order for other Wheels users to quickly identify and install your plugin via
"author":"YOURNAME",
// Required: GitHub Repository stub
"location":"GITHUBUSERNAME/GITHUB-REPONAME#v0.0.1",
// Required: Should always be /app/plugins/
"directory":"/app/plugins/",
// Required: Should always be /plugins/
"directory":"/plugins/",
// Required: Should always be true
"createPackageDirectory":true,
// Required: Must be the name of your primary CFC File
Expand Down Expand Up @@ -110,8 +110,8 @@ Your completed `box.json` might look something like this:
"author":"Tom King",
// Required: GitHub Repository stub, including version hash
"location":"neokoenig/wheels-shortcodes#v0.0.4",
// Required: Should always be /app/plugins/
"directory":"/app/plugins/",
// Required: Should always be /plugins/
"directory":"/plugins/",
// Required: Should always be true
"createPackageDirectory":true,
// Required: Must be the name of your primary CFC File
Expand Down Expand Up @@ -159,7 +159,7 @@ Both Wheels CLI and Forgebox are expecting a tagged release with the plugin cont
1. Navigate into the plugin directory
2. Ensure that directory is authorized to publish the repo (e.g. `git remote -v` should list your fetch/push endpoints)

> Note: Git dislikes nested repos, so it's best to setup a test wheels site specifically for plugin development/deployment. Then `git init` within each plugin directory itself, but not at the root. (e.g. `/app/plugins/PluginName/`)
> Note: Git dislikes nested repos, so it's best to setup a test wheels site specifically for plugin development/deployment. Then `git init` within each plugin directory itself, but not at the root. (e.g. `/plugins/PluginName/`)

{% code title="CommandBox" %}
```shell
Expand Down
6 changes: 3 additions & 3 deletions docs/src/working-with-wheels/directory-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ vendor

**app/global/** - Holds globally accessible functions available throughout your application.

**app/plugins/** - Contains downloaded Wheels plugins that extend your application's functionality.
**plugins/** - Contains downloaded Wheels plugins that extend your application's functionality.

**Database Management** - Use the migration system (`wheels db migrate`) rather than manual SQL scripts for database schema changes.

Expand Down Expand Up @@ -160,7 +160,7 @@ When working on applications, your primary focus areas are:
- **Configuration:** `config/` directory for all settings
- **Application Logic:** `app/controllers/`, `app/models/`, `app/migrator/migrations`, `app/views/`, and `app/events/`
- **Static Assets:** `public/files/`, `public/images/`, `public/javascripts/`, and `public/stylesheets/`
- **Extensions:** `app/plugins/` for third-party functionality
- **Extensions:** `plugins/` for third-party functionality

### Framework Context

Expand Down Expand Up @@ -209,7 +209,7 @@ You can add additional directories to your application structure. When doing so:

**Asset Organization** - Use the conventional `public/` subdirectories for different asset types. This ensures Wheels functions work as expected and maintains project organization.

**Plugin Integration** - Evaluate existing plugins in `app/plugins/` before developing custom solutions.
**Plugin Integration** - Evaluate existing plugins in `plugins/` before developing custom solutions.

**Database Management** - Use the migration system (`wheels db migrate`) rather than manual SQL scripts for database schema changes.

Expand Down
Loading