m/umami
1
0
Fork 0
mirror of https://github.com/kremalicious/umami.git synced 2024-11-16 02:05:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

reset readme

Browse Source
This commit is contained in:
Manda Putra 2022-01-08 00:32:56 +07:00
parent 7d9372baa7
commit f10a8224f1
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -18,7 +18,7 @@ A detailed getting started guide can be found at [https://umami.is/docs/](https:
``` ```
git clone https://github.com/mikecao/umami.git git clone https://github.com/mikecao/umami.git
cd umami cd umami
yarn npm install
``` ```
### Create database tables ### Create database tables
@ -50,7 +50,6 @@ HASH_SALT=(any random string)
``` ```
The connection url is in the following format: The connection url is in the following format:
``` ```
postgresql://username:mypassword@localhost:5432/mydb postgresql://username:mypassword@localhost:5432/mydb
@ -61,16 +60,14 @@ The `HASH_SALT` is used to generate unique values for your installation.
### Build the application ### Build the application
For development purpose, you need to build first that is because the application need to prepare language and geo setting.
```bash ```bash
yarn build npm run build
``` ```
### Start the application ### Start the application
```bash ```bash
yarn start npm start
``` ```
By default this will launch the application on `http://localhost:3000`. You will need to either By default this will launch the application on `http://localhost:3000`. You will need to either
@ -86,13 +83,11 @@ docker-compose up
``` ```
Alternatively, to pull just the Umami Docker image with PostgreSQL support: Alternatively, to pull just the Umami Docker image with PostgreSQL support:
```bash ```bash
docker pull ghcr.io/mikecao/umami:postgresql-latest docker pull ghcr.io/mikecao/umami:postgresql-latest
``` ```
Or with MySQL support: Or with MySQL support:
```bash ```bash
docker pull ghcr.io/mikecao/umami:mysql-latest docker pull ghcr.io/mikecao/umami:mysql-latest
``` ```
@ -103,8 +98,8 @@ To get the latest features, simply do a pull, install any new dependencies, and
```bash ```bash
git pull git pull
yarn npm install
yarn build npm run build
``` ```
## License ## License