Files
kener/docs/quick-start.md
T
Raj Nandan Sharma d931f3ec6d fix: fixed docs
2024-12-04 17:52:14 +05:30

54 lines
1.0 KiB
Markdown

---
title: Quick Start | Kener
description: Get started with Kener
---
# Quick Start
Here is a demonstration of how to get started with Kener in seconds
## Requirements
- Node.js Minimum version required is `v22.12.0`.
- Git
- sqlite3
## Clone the repository
```shell
git clone https://github.com/rajnandan1/kener.git
cd kener
```
## Install Dependencies
```shell
npm install
```
## Setup Configuration
- Rename `config/site.example.yaml` -> `config/site.yaml`
- Rename `config/monitors.example.yaml` -> `config/monitors.yaml`
- Rename `config/server.example.yaml` -> `config/server.yaml`
```shell
cp config/site.example.yaml config/site.yaml
cp config/monitors.example.yaml config/monitors.yaml
cp config/server.example.yaml config/server.yaml
```
## Start Kener
```bash
npm run dev
```
Kener Development Server would be running at PORT 3000. Go to [http://localhost:3000](http://localhost:3000)
## Next Steps
- [Configure Site](/docs/customize-site)
- [Add Monitors](/docs/monitors)
- [Alerting](/docs/alerting)