Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phcdevworks/phcdevworks_accounts_stytch
PHCDevworks Accounts Stytch is an authentication system that integrates with the Stytch API to provide seamless B2B and B2C user authentication for Ruby on Rails apps.
https://github.com/phcdevworks/phcdevworks_accounts_stytch
authentication bradpotts stytch
Last synced: 2 months ago
JSON representation
PHCDevworks Accounts Stytch is an authentication system that integrates with the Stytch API to provide seamless B2B and B2C user authentication for Ruby on Rails apps.
- Host: GitHub
- URL: https://github.com/phcdevworks/phcdevworks_accounts_stytch
- Owner: phcdevworks
- License: mit
- Created: 2024-07-10T12:48:26.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-03T03:06:57.000Z (4 months ago)
- Last Synced: 2024-10-31T14:10:46.208Z (3 months ago)
- Topics: authentication, bradpotts, stytch
- Language: Ruby
- Homepage:
- Size: 269 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: FUNDING.yml
- License: MIT-LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# PHCDevworks Accounts Stytch
## Overview
[](https://codecov.io/gh/phcdevworks/phcdevworks_accounts_stytch)
[](https://github.com/phcdevworks/phcdevworks_accounts_stytch/actions/workflows/github-code-scanning/codeql)
PHCDevworks Accounts Stytch is an authentication system that integrates with the Stytch API to provide seamless B2B and B2C user authentication for Ruby on Rails apps. The project includes:
## Key Features:
- **Magic Link Authentication**: Users can authenticate via secure magic links sent to their email.
- **Password Authentication**: Support for password-based login and reset flows, including registration and session management.
- **Password Reset Management**: Users can reset their passwords via email, token, existing password, or session token.
- **Organization Support**: The B2B module includes organization-specific user authentication with integration of organization IDs.
- **Service Handling**: All service actions are abstracted into service objects that handle interaction with Stytch’s API for better maintainability and testability.
- **Error Handling & Logging**: Robust error logging and consistent handling of service responses ensure reliability and traceability of issues.
## Usage
### 1. Set up Stytch API credentials
You will need to store your Stytch API credentials securely in your Rails `credentials.yml.enc` file. Follow these steps to open and edit the credentials file:
1. Ensure you have the `master.key` file located in `config/master.key`.
2. Open the encrypted credentials file using the following command in your terminal:
```bash
rails credentials:edit
```
3. This will open the credentials file in your default text editor (or VSCode if configured). In the file, add your Stytch API credentials under both b2b and b2c keys, as shown below:
```yml
stytch:
b2b:
project_id:
secret:
b2c:
project_id:
secret:
```
4. Save and close the file. Rails will automatically re-encrypt the credentials.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "phcdevworks_accounts_stytch"
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install phcdevworks_accounts_stytch
```
## Contributing
[](https://github.com/phcdevworks/phcdevworks_accounts_stytch/graphs/contributors)
[](#contributors-)
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
