Sprocket Docs

Companion documentation for Sprocket, a real-time server-side components library for Gleam.

Introduction

This project is built using Gleam and TypeScript, and managed with Yarn.

Installation

To install this project, follow these steps:

1. Clone the repository from GitHub.
2. Install the required dependencies using npm install or yarn install.
3. Build the project using npm run build or yarn build.
4. Start the project using npm run watch or yarn watch.

Usage

Once you have installed and started the project, you can use it to explore Sprocket

Contributing

We welcome contributions from the community. If you find an error in the docs or would like to contribute, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request.

License

This project is licensed under the MIT license. See the LICENSE file for more information.