# climine
> A lightweight web runtime that facilitates easy web development
Latest version **0.1.7** (published 2024-06-03) · MIT license · 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install climine
pnpm add climine
yarn add climine
bun add climine
```
Provides the command `climine`.
## Health
**Score 10/100 (F)** — status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 0.1.7 |
| Published | 2024-06-03 |
| First published | 2024-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 327 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Vishok Manikantan |
| Maintainers | mvishok |
| Keywords | climine, runtime, web, development |
## Links
- npm: https://www.npmjs.com/package/climine
- Repository: https://github.com/climine/runtime
- Homepage: https://climine.github.io/runtime
- Issues: https://github.com/climine/runtime/issues
- npm.io page: https://npm.io/package/climine
## Dependencies (7)
- [boxen](https://npm.io/package/boxen.md) ^7.1.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [minimist](https://npm.io/package/minimist.md) ^1.2.8
- [expr-eval](https://npm.io/package/expr-eval.md) ^2.0.2
- [then-request](https://npm.io/package/then-request.md) ^6.0.2
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10
- [better-sqlite3](https://npm.io/package/better-sqlite3.md) ^11.0.0
## Alternatives
- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads
## Recent versions
- 0.1.7 (latest) — 2024-06-03
- 0.1.6 — 2024-05-30
- 0.1.5 — 2024-05-24
- 0.1.3 — 2024-05-04
- 0.1.2 — 2024-04-25
- 0.1.0 — 2024-04-19
## README
# Climine Runtime
Climine Runtime is a lightweight and straightforward runtime environment for web development designed to streamline the process of building dynamic websites, without the complexity of traditional backend setups or server-side scripting languages. With Climine Runtime, developers can easily convert static HTML/CSS/JS designs into dynamic web applications by integrating API responses directly into their HTML markup.
## Who is it for?
- **Beginners:** Climine Runtime offers a user-friendly solution for those new to web development, providing a gentle introduction to dynamic web content.
- **Small Projects:** For quickly prototyping and deploying simple dynamic websites without the need for extensive backend infrastructure.
## Installation
To install Climine Runtime, you have a couple of options:
- ### Using Pre-built Binaries
You can download pre-built binaries for your operating system from the [Releases](https://github.com/climine/climine-runtime/releases/latest) page. Once downloaded, extract the archive and add the executable to your system's PATH.
- ### Compiling from Source
If pre-built binaries are unavailable for your operating system, you can compile Climine Runtime from source. Follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/climine/climine-runtime.git
```
2. Navigate to the project directory:
```bash
cd runtime
```
3. Install dependencies:
```bash
npm install
```
4. Build the project:
```bash
npm run build
```
5. The compiled binary will be available in the dist directory.
That's it! You're now ready to use Climine Runtime.
## Usage/Examples
Let's walk through an example of using Climine Runtime to create a simple dynamic website. We'll start by defining our project structure and then showcase the contents of the configuration files, HTML markup, and API request file.
### Project Structure
```bash
my-climine-project/
├── config.json
├── index.html
└── index.json
```
### Configuration (config.json)
```json
{
"port": 8080,
"dir": "./",
"errors": {
"404": "/error/404/"
}
}
```
### API Request File (index.json)
```json
{
"request1": {
"to": "https://api.example.com/data&q={{query}}",
"method": "GET",
"headers": {
"Content-Type": "application/json"
},
"require": {
"query": null
}
}
}
```
### HTML Markup (index.html)
```html
My Climine Project
Welcome to Climine Runtime!
This is a dynamic website powered by Climine.
Here's some dynamic content:
{{ request1.responseKey }}
```
In this example, `config.json` defines the configuration for the Climine Runtime. `index.html` contains the HTML markup, while `index.json` defines an API request that fetches dynamic data to be inserted into that HTML markup
## Features
- **API Requests:** Define and execute API requests directly within HTML files using simple configuration syntax.
- **HTTP Method Support:** Handle GET and POST variables when users visit Climine projects, allowing for dynamic interaction with client-side content.
- **Custom Error Pages:** Configure error pages for graceful error responses
- **Dynamic Content Rendering:** Automatically render dynamic content fetched from API responses directly into HTML markup.
- **Minimal Configuration:** Requires minimal setup and configuration for rapid development of dynamic websites.
## Support
For support or inquiries, please use the [Issues](https://github.com/climine/climine-runtime/issues) section on this GitHub Repo. We'll do our best to assist you promptly!
## License
Climine Runtime is licensed under the [MIT](https://github.com/climine/climine-runtime/blob/main/LICENSE) License. See LICENSE for more information.
---
_Source: https://npm.io/package/climine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._