etimo / etimo-achievements

Slack achievements!

etimo-achievements

Etimo Achievements is a simple, open-source, web-based platform for managing and sharing achievements.

It is used by Etimo to create, track and hand out achievements on Slack.

Contributing

If you want to contribute to this project, see the Contributing file for information on how to get started.

Technologies

These are the technologies used in this project:

Technology	Description
Docker	Containers are used in local development and in production.
ESLint	Code linting.
Express	Express is used for the API.
GNU Bash	CI/CD scripts.
GitHub Actions	Continuous integration/deployment.
Husky	Git hooks.
Jest	Unit testing.
Knex	DB access, migrations and seed files.
Kubernetes	Container orchestration.
Node.js	Server-side JavaScript for the backend.
Nodemon	Change monitoring during development.
Objection.js	ORM for Knex.
Postgres	SQL database.
Prettier	Code formatting.
Swagger	API documentation (OpenAPI v3).
TypeScript	Strong typing.
Yarn	Package manager & workspaces.

etimo-achievements's Issues

yarn docker-rebuild is failing

src/database.ts(1,64): error TS2307: Cannot find module '@etimo-achievements/common' or its corresponding type declarations.
src/models/achievement-model.ts(1,22): error TS2307: Cannot find module '@etimo-achievements/common' or its corresponding type declarations.
src/models/user-achievement-model.ts(1,22): error TS2307: Cannot find module '@etimo-achievements/common' or its corresponding type declarations.
src/models/user-model.ts(1,22): error TS2307: Cannot find module '@etimo-achievements/common' or its corresponding type declarations.
src/utils/catch-errors.ts(1,84): error TS2307: Cannot find module '@etimo-achievements/common' or its corresponding type declarations.

Swagger

https://swagger.io/specification/#componentsObject

https://github.com/Surnet/swagger-jsdoc/blob/v7/examples/app/swagger-spec.json

Deploy till produktion

Vi behöver deploya till produktion genom att tagga om staging-imagen och deploya heroku-appen.

Self-award Obama-bild

När man ger sig själv en award ska obama-bilden visas.

Paginering på achievements

Gör så att achievements pagineras.

Improve api documentation

The requests & responses descriptions should be consolidated & improved.

Add Swagger docs to existing endpoints

Add Swagger documentation to existing endpoints.

Stop staging deploys after tests in PR

Should only deploy if tests were done on master branch.

Move database errors to data package

Some errors that are database specific are located in service. They should be moved to data package.

Dockerfile för web behöver förbättras

Den borde servas från nginx t ex.

Use local dependencies

Get rid of global dependencies.

Bekräftelse vid delete achievement

När man tar bort achievements bör man få en bekräftelsedialog.

Create examples for all dtos

All properties should have examples.

 *         achievement:
 *           type: string
 *           description: The name of the achievement
 *           example: <insert example here>

Google Oauth

Add logger class

Add placeholder APIs

Add not yet implemented APIs.

Implement supertest

https://www.npmjs.com/package/supertest

Refresh token-funktionalitet

Self award should produce meme picture in slack message

When a user gives an achivement to himself it should attach the obama meme in the response message.

Reduce objection validation with json schema

We have too much validation in our objection models.

The objection json schema should only validate the table requirements.

Slackbot should be able to create achievements

Achievements should be able to be created by using the slack bot.
To make it easier for the user a window should appear where the user is asked to name the achievement and write a description of the achievement.

Topplista

Vi behöver en topplista.

GET /highscore

Den ska skapa en highscore utifrån vilka användare som finns, och vilka achievements de har.

Reorder routes

Reorder the routes to make swagger more readable.

• Should be ordered alphabetically.
• Should be ordered GET, POST for each route.

Achievement Model

Lägga till en modell för Achievements.

Slack-bott med /commands

En Slack-bott som anropar vårt API

Tillhörande endpoints. Få upp en basal snurra som reagerar på Slack-events.

Implement POST /awards

Implement the /awards POST endpoint.

Implement GET /awards

Implement the /awards GET endpoint.

Debug i vscode med webpack fungerar inte

Går inte att sätta stoppoints.

Visa bara sidor som användaren har rätt att se

Scopes kommer avgöra vilka sidor du får titta på

Visa inte achievements-listan om man bara har w:achievements t ex.

Fixa felhantering

Just nu så fångas inte fel av vår error handler. Fixa det.

Entities package

Move entities to their own package so they can be referenced by all packages.

Oauth2 login

We need a way to login to the admin interface. Until we have an admin interface, we should have a password login flow with OAuth2 to get a jwt token that we can use in Postman.

Or maybe use our Gmail accounts (@Etimo) to login and create local users?

Express-API med CRUD-operationer

En fungerande snurra med endpoint, service, repository, mappers, etc.

Errors are not caught and output to console

Try creating a user. It returns a 500 error. But nowhere is this logged.

Bygg bara beroende paket

Om jag uppdaterar t ex express-middleware paketet, så vill jag inte att nodemon bygger om alla paket.

Den borde bara bygga om express-middleware + alla paket som BEROR på det, och som beror på paketen som byggs om.

Lägg in version.json i web

/version på web borde returnera versionsinformation från /src/version.json

OS X and Linux formats code differently

When saving in vs code, the code gets formatted differently on different platforms.

We should include settings in .vscode that makes this behaviour the same on all platforms.

Run tests before deploying and on PRs

Local /version endpoint is not working

api_1       | Error: Cannot find module './version.json'
api_1       | Require stack:
api_1       | - /app/packages/api/dist/resources/version.js
api_1       | - /app/packages/api/dist/resources/index.js
api_1       | - /app/packages/api/dist/server.js
api_1       | - /app/packages/api/dist/index.js
api_1       |     at Function.Module._resolveFilename (internal/modules/cjs/loader.js:902:15)
api_1       |     at Function.Module._load (internal/modules/cjs/loader.js:746:27)
api_1       |     at Module.require (internal/modules/cjs/loader.js:974:19)
api_1       |     at require (internal/modules/cjs/helpers.js:93:18)
api_1       |     at VersionController.getVersion (/app/packages/api/dist/resources/version.js:9:22)
api_1       |     at /app/packages/api/dist/utils/endpoint-helper.js:6:9
api_1       |     at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)
api_1       |     at next (/app/node_modules/express/lib/router/route.js:137:13)
api_1       |     at Route.dispatch (/app/node_modules/express/lib/router/route.js:112:3)
api_1       |     at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)

Cannot get resource or create resource

Creating and getting single resources seem broken.

OpenApi generator hook

Add pre-commit hook for openapi spec generation.

Logout funkar inte i molnet

Det funkar lokalt, men inte i molnet.

Cookies verkar inte tas bort av /logout

Förbättrad loggning

Just nu är Logger-klassen lite väl enkel.

Förbättra den så den har olika loggnivåer och kan hålla ett kontext som den loggar.

User Achievement Connection

We need to know which user has which achievements.

Same naming convention accross files

The HTTP apis are in plural:
/users
/awards
/achievements

but the service, repositores are in singluar.

Achievement service

Autentisering

Steg 1 blir att använda en api key i headern som måste matcha en ENV-variabel.

Dependency tree script

Write a script that lists the packages in dependency order.

Scopes

Lägg till scopes på token och avgör om man får access till endpoints baserat på detta.

Ändra achievements

Gör så man kan ändra achievements.

En penna i listan. Modal popup.