README cleanup

pull/680/head
Philipp Dormann 2021-05-22 19:16:46 +02:00
parent 1d634c0c53
commit dfa2779979
3 changed files with 12 additions and 13 deletions

1
.env.example Normal file
View File

@ -0,0 +1 @@
HASH_SALT=xSSHW4A2w0e3vxLUp46XL9OzCGKvxEnA

View File

@ -5,5 +5,5 @@ COPY package.json /build/
RUN yarn RUN yarn
COPY . /build COPY . /build
RUN yarn build RUN yarn build
RUN yarn prisma migrate dev # RUN yarn prisma migrate dev
CMD ["yarn", "start"] CMD ["yarn", "start"]

View File

@ -1,9 +1,9 @@
# umami-sqlite # 🧭 umami-sqlite
Modded version of [Umami Analytics](https://umami.is) backed by a local SQLite database Modded version of [Umami Analytics](https://umami.is) backed by a local SQLite database
> simple, fast, open source website analytics
Umami is a simple, fast, website analytics alternative to Google Analytics. ## Quick Start
### Requirements
## Getting started
- Node.js >= 14.17.0 - Node.js >= 14.17.0
### Install Dependencies ### Install Dependencies
@ -12,31 +12,29 @@ Umami is a simple, fast, website analytics alternative to Google Analytics.
yarn yarn
``` ```
### Run db migration ### (seemingly optional?) Run db migration
``` ```
yarn prisma migrate dev yarn prisma migrate dev
``` ```
### Configure umami ### Configure env
Create an `.env` file with the following Create an `.env` file with the following
``` ```
HASH_SALT=(any random string) HASH_SALT=anyrandomstring
``` ```
### Build the application ### Build the application
```bash ```bash
npm run build yarn build
``` ```
### Start the application ### Start the application
```bash ```bash
npm start yarn start
``` ```
By default this will launch the application on `http://localhost:3000`. You will need to either The application will be available on `http://localhost:3000`.
[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server
or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.