lynndylanhurley / lynndylanhurley/devise_token_auth
Update docs for devise install
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 3.6k
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
Following the gitbook docs, for a Rails 7.0.2.4 API-only app with devise_token_auth 1.2.1 and devise 4.9.0, without running `rails generate devise:install` before `rails g devise_token_auth:install User auth`, then attempting to migrate the db or do anything will result in the error:
> NoMethodError: undefined method `devise' for User:Class
Whatever devise:install does, it seems to be needed so it might be good to add that atop the 'Configuration' page on the gitbook docs.
Thanks for making and maintaining a great gem!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the GitBook Configuration page and the documented devise_token_auth installation command for Rails API-only apps. Verify the reported sequence with the listed Rails, devise_token_auth, and devise versions. Done means the page explains that rails generate devise:install is needed before the token-auth install command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rails, ruby
- Domain
- authentication, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100