/jwt-auth

Build a Rails 6.1.3 user authentication syste using JWT

Primary LanguageRubyMIT LicenseMIT

jwt-auth

README

A complete Rails 6.1.3 user authentication syste using JWT gem. Read the documentation for sample code on testing the api endpoints.

What it does

  • Receives request to create new user with valid params
  • Updates user with valid params
  • Has a confirm password with email delivery feature.
  • Has a password recovery with email password recovery generation token
  • Has a delete your account feature.

Built With

  • Ruby v2.7.2
  • Ruby on Rails v6.1.3

Gems used:

  • Jwt

  • figaro

  • bcrypt

  • Jbuilder

  • Gems used for testing:

    • Rspec-rails
    • Rubocop
    • factory_bot_rails
    • Shoulda matchers

  • Rubocop

Live Link to api

Live link to api

Getting Started

To get a local copy up, clone it and running follow these simple example steps.

Prerequisites

  • Ruby: 2.7.2
  • Rails: 6.1.3
  • Postgres: >= 9.5

Setup

Install gems with:

bundle install

Setup database with:

   rails db:create
   rails db:migrate

Usage

Start server with:

    rails server

Test endpoints using postman or you favorites software.

Visit documentation for sample codes.

Run tests

    rpsec

Deployment

  • App deployed in Heroku.

Author

👤 Kelly Booster

🤝 Contributing

Contributions, issues and feature requests are welcome! Start by:

  • Forking the project.
  • Cloning the project to your local machine.
  • cd into the project directory.
  • Run git checkout -b your-branch-name.
  • Make your contributions.
  • Push your branch up to your forked repository.
  • Open a Pull Request with a detailed description to the development branch of the original project for a review.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

📝 License

No license.