mirror of
https://github.com/logto-io/logto.git
synced 2024-12-16 20:26:19 -05:00
docs: init introduction
This commit is contained in:
parent
9e90a6197c
commit
7d8821aa25
2 changed files with 37 additions and 2 deletions
7
.vscode/settings.json
vendored
7
.vscode/settings.json
vendored
|
@ -19,5 +19,10 @@
|
||||||
],
|
],
|
||||||
"editor.codeActionsOnSave": {
|
"editor.codeActionsOnSave": {
|
||||||
"source.fixAll.eslint": true,
|
"source.fixAll.eslint": true,
|
||||||
}
|
},
|
||||||
|
"cSpell.words": [
|
||||||
|
"Alipay",
|
||||||
|
"Logto",
|
||||||
|
"Passwordless"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,4 +4,34 @@ sidebar_position: 1
|
||||||
|
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
🤘 Logto is an open-source customer identity solution.
|
🤘 Logto helps you quickly focus on everything after signing in with the following components:
|
||||||
|
|
||||||
|
- All-platform user sign-in / sign-up experience with SDK support (SPA, iOS and Android)
|
||||||
|
- Passwordless (SMS / Email) support
|
||||||
|
- Out-of-box social sign in support (GitHub, Google, WeChat, Alipay, etc.)
|
||||||
|
- A web UI to control all above (Admin Console)
|
||||||
|
- Extendable multi-language support
|
||||||
|
- Easy deployment
|
||||||
|
|
||||||
|
Boringly, we call it "[customer identity access management](https://en.wikipedia.org/wiki/Customer_identity_access_management)" or "customer identity solution".
|
||||||
|
|
||||||
|
# Get Started
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- NodeJS >= 16.0.0
|
||||||
|
- PostgreSQL >= 14.0.0
|
||||||
|
|
||||||
|
It's okay that your PostgreSQL instance is not in the same machine as NodeJS (e.g. containers + remote database environment).
|
||||||
|
|
||||||
|
## Run Logto
|
||||||
|
|
||||||
|
### Download Script
|
||||||
|
|
||||||
|
In your terminal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node -e "$(printf "%s" "$(curl -fsSL https://raw.githubusercontent.com/logto-io/logto/master/install.js)")"
|
||||||
|
```
|
||||||
|
|
||||||
|
The script will download Logto and create a directory `logto` in the location you ran it.
|
||||||
|
|
Loading…
Reference in a new issue