github.com/luckyframework/authentic

An authentication library for Lucky projects

15 stars

84 dependents

License: MIT

Installation

# Add this to your shard.yml
dependencies:
  authentic:
    github: luckyframework/authentic
    version: ~> 1.0.2

Then run:

shards install

shard.yml

Crystal: >= 1.10.0
License: MIT
Author: Paul Smith

Dependencies

Runtime Dependencies

avram>= 1.0.0github: luckyframework/avram
lucky>= 1.0.0github: luckyframework/lucky
habitat~> 0.4.9github: luckyframework/habitat

Development Dependencies

ameba~> 1.5.0github: crystal-ameba/amebadev

README

Authentic

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

Installation

Authentic is bundled in Lucky projects automatically.

Contributing

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

Testing

To run the tests:

Install docker and docker-compose: https://docs.docker.com/compose/install/
Run scripts/setup to set up the docker environment
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

paulcsmith Paul Smith - creator, maintainer