An authentication service to fulfill your needs.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
SeeTrue is an authentication service, which handless user authetication, token management, mailing for you.
SeeTrue is composed by the following components:
- SeeTrue.API - a fast API written in dotnet core 6, fully dockerized and customizable through environment variables.
- SeeTrue.Admin - a standalone web app to connect to your SeeTrue.API instance to manage your users and email templates.
- SeeTrue.Client a node | browser javascript client to interact with your SeeTrue.API instance.
- SeeTrue.Client.React - A react package which wraps SeeTrue.Client int a React context, and it provides a hook to acces the client, check authentication status, user information, tokens.
SeeTrue started as GoTrue reimplementation, but the project quickly shifted into a different direction. Please check out GoTrue and support them with a star 😄
Built with hard work, tears, sweat, dedication and love.
Setup a SeeTrue.API instance (SeeTrue.API docs), then connect your backend or frontend app (Typescript client) (React client). In case you are getting you tokens directly in a frontend application and you would like to use em to access your backend too, please configure you backend tokenvalidation to the same values as configured for the SeeTrue.API instance.
Before connectiong setting app your app connection to the SeeTrue.API instance, please make sure you created all the email templates (Example email templates). These email templates are written in MJML, if you are creating the email templates directly then you need to compile them to HTML. An Another option is to SeeTrue.Admin. All the emails are using Stubble as a templating engine. Make suru to use the same Name key for the users name, as specified in the SeeTrue.API instance configuration (The default key is Name ehich is used in the example templates).
In case you would like to implement a custom client please check out the REST API specs.
The database migration are part o the SeeTrue.API application. To increase the speed, the migrations dont contain default email template data.
For a quick setup use the provided docker compose file. After your containers are running you have to create the email templates and after that you are up and running.
- Publish docker images
- Publish npm packages
- Implement webhooks
- SQLite support
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Project Link: https://github.com/TheOnlyBeardedBeast/SeeTrue