Skip to content

Installation

To use the Grip framework in a Crystal application, you must add it as a dependency in the project’s shard.yml file and install it using the shards command. This ensures the framework is available for building RESTful web applications.

1. Update shard.yml

Add the Grip dependency to your project’s shard.yml file, located in the project root directory. This file specifies the project’s metadata and dependencies.

# shard.yml: Configuration file for project dependencies and metadata.
dependencies:
  grip: # Specifies the Grip microframework for building RESTful APIs.
    github: grip-framework/grip # References the Grip repository on GitHub.

2. Install Dependencies

Run the following command in your terminal to install the dependencies listed in shard.yml:

# Installs dependencies specified in shard.yml, downloading Grip to the lib/ directory.
shards install