Skip to content

An authentication library for Lucky projects

License

Notifications You must be signed in to change notification settings

luckyframework/authentic

Repository files navigation

Authentic

API Documentation Website

A Crystal library for handling common authentication actions in Lucky projects.

Installation

Authentic is bundled in Lucky projects automatically.

Contributing

  1. Fork it ( https://github.com/luckyframework/authentic/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Install docker and docker-compose: https://docs.docker.com/compose/install/
  4. Run scripts/setup
  5. Make your changes
  6. Run scripts/test to run the specs, build shards, and check formatting
  7. Commit your changes (git commit -am 'Add some feature')
  8. Push to the branch (git push origin my-new-feature)
  9. Create a new Pull Request

Testing

To run the tests:

  1. Install docker and docker-compose: https://docs.docker.com/compose/install/
  2. Run scripts/setup to set up the docker environment
  3. Run scripts/test to run the specs, build shards, and check formatting

You can run individual tests like this: docker-compose run --rm app crystal spec path/to/spec.cr

Remember to run docker-compose down when you're done. This will stop the Crystal container.

Contributors