dynnammo / dev-excuses Goto Github PK

Since our application relies on heavy features like :

• external database management with different tables
• i18n

We should consider moving to a more complete Crystal web framework.
Requirements that should be met :

• workflows easily adaptable
• test suire easily adaptable
• dockerfiles and docker-compose.yml

Candidates

• Lucky : close to mature
• Marten : very early stage, but promising

Currently, the excuses are stored using redondant keys.

It would be better to have an ID for each key.

Implies to switch to a model-based approach, keeping the yaml storing for now

In order to have #4, it would be great to provide tags for each excuse

• Tag each excuse. Tags should be translatable
• Retrieve an excuse based on its tag

Currently, the application is only available through cURL calls.

It would be great to both have an API side and also a package delivering excuses when imported.

Currently, the API has a single endpoint that returns a random excuse

We would like to have the possibility to ask for a specific one providing its ID

Since we want to provide a public endpoint for the API to work, it'll be great to implement a JWT authentication.

Documentation worse useful :

• https://auth0.com/blog/ruby-authentication-secure-rack-apps-with-jwt/
• https://github.com/crystal-community/jwt
• https://jwt.io/introduction/

They're is not only devs in current startups : it'll be great to retrieve excuses for product manager, marketing, accounting etc.

Not-exhaustive list of all jobs that could be excusable :

• developer
• front-end developer
• data analyst
• admin sys
• testing
• product owner

Add i18n management using provided instance of Weblate of self-hosted one.

Currently, errors are low-level defined.

We should move to a more abstract level by designing NotFoundException, InvalidRequestException, NotAuthorizedException etc.

Using an external database like Baserow, Appwrite or Strapi in order to store data in a proper database system.

Such system should be i18n-proof.

Alternative ways : classical Postgres / DBMS database