2021-05-22 18:09:28 +02:00
|
|
|
# umami-sqlite
|
|
|
|
|
Modded version of [Umami Analytics](https://umami.is) backed by a local SQLite database
|
2020-08-13 10:41:11 +02:00
|
|
|
|
2020-08-19 23:35:38 +02:00
|
|
|
Umami is a simple, fast, website analytics alternative to Google Analytics.
|
|
|
|
|
|
|
|
|
|
## Getting started
|
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
|
2020-08-13 10:41:11 +02:00
|
|
|
|
|
|
|
|
```
|
2021-05-22 18:09:28 +02:00
|
|
|
yarn
|
2020-08-13 10:41:11 +02:00
|
|
|
```
|
|
|
|
|
|
2021-05-22 18:09:28 +02:00
|
|
|
### Run db migration
|
2020-08-13 10:41:11 +02:00
|
|
|
```
|
2021-05-22 18:09:28 +02:00
|
|
|
yarn prisma migrate dev
|
2020-08-13 10:41:11 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Configure umami
|
|
|
|
|
|
|
|
|
|
Create an `.env` file with the following
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
HASH_SALT=(any random string)
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-21 11:22:07 +02:00
|
|
|
### Build the application
|
2020-08-13 10:41:11 +02:00
|
|
|
|
2020-09-06 07:44:56 +02:00
|
|
|
```bash
|
2020-08-13 10:41:11 +02:00
|
|
|
npm run build
|
2020-08-17 06:28:54 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Start the application
|
|
|
|
|
|
2020-09-06 07:44:56 +02:00
|
|
|
```bash
|
2020-08-17 06:28:54 +02:00
|
|
|
npm start
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
By default this will launch the application on `http://localhost:3000`. You will need to either
|
|
|
|
|
[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server
|
2021-05-22 18:09:28 +02:00
|
|
|
or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.
|
