Skip to content

Commit

Permalink
docs (#14)
Browse files Browse the repository at this point in the history
* docs

* instructions

* fix name
  • Loading branch information
microstudi authored Apr 15, 2024
1 parent e60439c commit 6d6e0a5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/c6a5d8808df0ea76bc30/maintainability)](https://codeclimate.com/github/openpoke/decidim-module-anonymous_codes/maintainability)
[![codecov](https://codecov.io/gh/openpoke/decidim-module-anonymous_codes/graph/badge.svg?token=Hbc6Uq50qe)](https://codecov.io/gh/openpoke/decidim-module-anonymous_codes)

TODO...
This module provides the ability restrict access to certain resources (currently Surveys) in Decidim by using anonymous codes. The implementation is based on the idea of providing a code to the user that allows them to access the resource without the need to be logged in.

However, it is also compatible with the setting "allow users to answer the survey without login" so administrators can decide wheter if users with valid codes need to be logged in or not.

## Installation

Expand Down Expand Up @@ -34,9 +36,16 @@ bin/rails db:migrate
## Usage
TODO...
The first step is to create a group of codes in the admin, for this there is a specific menu in the admin panel.
When a group is created, then the admin can generate codes for that group. The codes can be generated in bulk.
A group can be set with and expiration date, make it active or not and link it to a particular resource (a survey in Decidim). Many groups can be linked to the same resource as well.
When a user tries to access a resource that is protected by anonymous codes, they will be prompted to enter the code.
### Configuration
Codes can also be exported and the final URL to answer the survey is provided in the exported file (with this URL the survey access will be granted without the need to enter the code).
## Configuration
By default, the module is configured to read the configuration from ENV variables.
Expand Down Expand Up @@ -68,7 +77,11 @@ end
## Screenshots
TODO....
![Survey restriction](docs/survey.png)
Admin panel
TODO
## Contributing
Expand Down
Binary file added docs/survey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6d6e0a5

Please sign in to comment.