umami/README.md

40 lines
584 B
Markdown
Raw Normal View History

2021-05-22 19:16:46 +02:00
# 🧭 umami-sqlite
2021-05-22 18:09:28 +02:00
Modded version of [Umami Analytics](https://umami.is) backed by a local SQLite database
2021-05-22 19:16:46 +02:00
> simple, fast, open source website analytics
2021-05-22 19:16:46 +02:00
## Quick Start
### Requirements
2021-05-22 18:09:28 +02:00
- Node.js >= 14.17.0
2020-08-19 23:35:38 +02:00
2021-05-22 18:09:28 +02:00
### Install Dependencies
```
2021-05-22 18:09:28 +02:00
yarn
```
2021-05-22 19:16:46 +02:00
### (seemingly optional?) Run db migration
```
2021-05-22 18:09:28 +02:00
yarn prisma migrate dev
```
2021-05-22 19:16:46 +02:00
### Configure env
Create an `.env` file with the following
```
2021-05-22 19:16:46 +02:00
HASH_SALT=anyrandomstring
```
2020-08-21 11:22:07 +02:00
### Build the application
```bash
2021-05-22 19:16:46 +02:00
yarn build
2020-08-17 06:28:54 +02:00
```
### Start the application
```bash
2021-05-22 19:16:46 +02:00
yarn start
2020-08-17 06:28:54 +02:00
```
2021-05-22 19:16:46 +02:00
The application will be available on `http://localhost:3000`.