mirror of
https://github.com/logto-io/logto.git
synced 2024-12-16 20:26:19 -05:00
1ce3211d1a
* chore: update README.md made it easy to understand and improved grammar * refactor: apply suggestions from code review --------- Co-authored-by: Gao Sun <gao@silverhand.io>
107 lines
5.5 KiB
Markdown
107 lines
5.5 KiB
Markdown
<p align="center">
|
|
<a href="https://logto.io" target="_blank" align="center" alt="Logto Logo">
|
|
<img src="./logo.png" height="120">
|
|
</a>
|
|
</p>
|
|
|
|
[](https://discord.gg/vRvwuwgpVX)
|
|
[](https://github.com/logto-io/logto/actions?query=branch%3Amaster)
|
|
[](https://github.com/logto-io/logto/releases)
|
|
[](https://app.codecov.io/gh/logto-io/logto)
|
|
[](https://cloud.logto.io/?sign_up=true&utm_source=github&utm_medium=repo_logto)
|
|
[](https://gitpod.io/#https://github.com/logto-io/demo)
|
|
[](https://render.com/deploy?repo=https://github.com/logto-io/logto)
|
|
|
|
Logto[^info] is a cost-effective open-source alternative to Auth0. It offers a seamless developer experience and is well-suited for individuals and growing companies.
|
|
|
|
🧑💻 **Comprehensive frontend-to-backend identity solution**
|
|
|
|
- Enables OIDC-based authentication and RBAC authorization.
|
|
- Supports passwordless sign-in, along with various options like Email, Phone number, Username, Google, Facebook, and other social sign-in methods.
|
|
- Offers beautiful UI components with customizable CSS to suit your business needs.
|
|
|
|
📦 **Out-of-the-box infrastructure**
|
|
|
|
- Includes a ready-to-use management API, serving as your authentication provider, thus eliminating the need for extra implementation.
|
|
- Provides SDKs that seamlessly integrate your apps with Logto across multiple platforms and languages, tailored to your development environment.
|
|
- Offers flexible connectors that can be scaled with community contributions and customized with SAML, OAuth, and OIDC protocols.
|
|
|
|
💻 **Enterprise-ready solutions**
|
|
|
|
- Implements Role-Based Access Control (RBAC) for scalable role authorization, catering to a wide range of use cases.
|
|
- Facilitates user management and provides audit logs for understanding identity-related user information and maintaining security.
|
|
- Currently working on Single Sign-On (SSO), Organizations, and Multi-Factor Authentication (MFA) features. Stay tuned!
|
|
|
|
In a more approachable way, we refer to this solution as "[Customer Identity Access Management (CIAM)](https://en.wikipedia.org/wiki/Customer_identity_access_management)" or simply, the "Customer Identity Solution."
|
|
|
|
[Subscribe to us](https://logto.io/subscribe/?utm_source=github&utm_medium=repo_logto) now to stay updated with the latest information about the Logto Cloud (SaaS) and receive feature updates in real-time.
|
|
|
|
|
|
## Get started
|
|
|
|
- Visit our 🎨 [website](https://logto.io/?utm_source=github&utm_medium=repo_logto) for a brief introduction if you are new to Logto.
|
|
- A step-by-step guide is available on 📖 [docs.logto.io](https://docs.logto.io/?utm_source=github&utm_medium=repo_logto).
|
|
|
|
### Interactive demo
|
|
|
|
- Try [Logto Cloud](https://cloud.logto.io/?sign_up=true&utm_source=github&utm_medium=repo_logto) to have the same dev experience and zero deployment overhead.
|
|
|
|
- If you launch Logto [via GitPod](https://gitpod.io/#https://github.com/logto-io/demo), please wait until you see the message like `App is running at https://3002-...gitpod.io` in the terminal, press Cmd (or Ctrl on Windows) and click the URL starts with `https://3002-` to continue your Logto journey.
|
|
|
|
### Launch Logto
|
|
|
|
#### Docker Compose
|
|
|
|
Docker Compose CLI usually comes with [Docker Desktop](https://www.docker.com/products/docker-desktop).
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/logto-io/logto/HEAD/docker-compose.yml | \
|
|
docker compose -p logto -f - up
|
|
```
|
|
|
|
#### npm-init
|
|
|
|
Requires [Node.js](https://nodejs.org/) `^18.12.0` + [PostgreSQL](https://postgresql.org/) `^14.0`.
|
|
|
|
```bash
|
|
npm init @logto
|
|
```
|
|
|
|
## Language support
|
|
|
|
```ts
|
|
const languages = ['Deutsch', 'English', 'Español', 'Français', 'Italiano', '日本語', '한국어', 'Polski', 'Português', 'Русский', 'Türkçe', '简体中文', '繁體中文'];
|
|
```
|
|
|
|
## Web compatibility
|
|
|
|
Logto uses the [default browserslist config](https://github.com/browserslist/browserslist#full-list) to compile frontend projects, which is:
|
|
|
|
```
|
|
> 0.5%, last 2 versions, Firefox ESR, not dead
|
|
```
|
|
|
|
## Bug report, feature request, feedback
|
|
|
|
- Our team takes security seriously, especially when it relates to identity. If you find any existing or potential security issues, please do not hesitate to email 🔒 [security@logto.io](mailto:security@logto.io).
|
|
- About other bug reports, feature requests, and feedback, you can:
|
|
- Directly 🙋 [open an issue](https://github.com/logto-io/logto/issues/new) on GitHub;
|
|
- 💬 [join our Discord server](https://discord.gg/vRvwuwgpVX) to have a live chat;
|
|
- Engage in our 📍 [public roadmap](https://github.com/logto-io/logto/issues/1937).
|
|
|
|
## Licensing
|
|
|
|
See the [LICENSE](LICENSE) file for licensing information as it pertains to files in this repository.
|
|
|
|
## Contributing
|
|
|
|
We have a [contributing guideline](https://github.com/logto-io/logto/blob/master/.github/CONTRIBUTING.md) available. Feel free to contact us before coding.
|
|
|
|
## Resources
|
|
|
|
- [📖 Logto docs](https://docs.logto.io/?utm_source=github&utm_medium=repo_logto)
|
|
- [✍️ Blog](https://blog.logto.io/?utm_source=github&utm_medium=repo_logto)
|
|
|
|
<br/>
|
|
|
|
[^info]: Designed by Silverhand Inc.
|