xdoubleu/essentia

This is a toolkit which contains reusable tools, helpers and such, allowing you to focus on the essence of your project.

essentia 🧰

essentia is a toolkit which contains reusable tools, helpers and such. This allows you to focus on the essence of your project. These tools are properly tested so that you can rely on their proper functioning.

I will add some smaller examples here in the near future. For now the larger examples and tests can be used as reference.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

For more information please read the CONTRIBUTING document.

License

MIT

essentia's Issues

Figure out required functionalities for MVP

Generic Views (as used in Django):
Django’s generic views... were developed as a shortcut for common usage patterns... They take certain common idioms and patterns found in view development and abstract them so that you can quickly write common views of data without having to repeat yourself.

Logging

Standard Configuration

Standard Middleware

Routing (with authenticated endpoints)

Input validation

Small testing library

Setup codecov

Use standard router instead of julienschmidt

Input validation & parsing

The validator should also parse data.

• The QueryValues
• The PathValues
• The RequestBody

And make these easily accessible through the context.

Standard configuration

Small testing library

Logging

Check CONTRIBUTING.md

Error handling for MVP features

Read effective go and adjust accordingly

• Getters & setters: field: owner;getter: Owner;setter: SetOwner
• One method interfaces are named by their method name + er; eg. method Read, interface Reader
• Variable names should be short if they have a limited scope and especially if they are used often

GoDoc?

Generic Views

src: https://www.django-rest-framework.org/api-guide/generic-views/#concrete-view-classes

Should be implemented as methods so developers can pick which ones to use (same as with mixins)

• Create (Post)

• List (Multiple Get)

• Retrieve (Single Get)

• Destroy (Delete)

• Update (Put & Patch)

• Generic (is base for all other & can do anything)

• Handling of these methods BTS

• Write docs on how to use with examples

Configure renovate

Setup workflows

• Run tests on change

Logging

Setup docs

Logging for framework

Only for dev environment, only to console
Use https://github.com/gookit/slog

Fix README.md

Setup renovate

Setup example project

Documentation (GitBook)

Parse and inject query and path params in handlers

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• Update module nhooyr.io/websocket to v1.8.17
• Update module github.com/golangci/golangci-lint/cmd/golangci-lint to v1.60.1
• Update module golang.org/x/time to v0.6.0

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update module github.com/getsentry/sentry-go to v0.28.1

Detected dependencies

docker-compose

docker-compose.yml

• postgres 16

github-actions

.github/workflows/main.yml

• actions/checkout v4
• actions/setup-go v5
• golangci/golangci-lint-action v6
• actions/checkout v4
• actions/setup-go v5
• codecov/codecov-action v4

gomod

go.mod

• go 1.22
• github.com/getsentry/sentry-go v0.27.0
• github.com/goddtriffin/helmet v1.0.2
• github.com/justinas/alice v1.2.0
• github.com/rs/cors v1.11.0
• golang.org/x/time v0.5.0
• github.com/google/uuid v1.6.0
• github.com/jackc/pgerrcode v0.0.0-20240316143900-6e2875d9b438@6e2875d9b438
• github.com/jackc/pgx/v5 v5.6.0
• github.com/stretchr/testify v1.9.0
• nhooyr.io/websocket v1.8.11

regex

Makefile

• github.com/golangci/golangci-lint/cmd/golangci-lint v1.59.1
• github.com/segmentio/golines v0.12.2
• github.com/daixiang0/gci v0.13.4
• github.com/securego/gosec/v2/cmd/gosec v2.20.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Documentation (Code)

Managed goroutines

Goroutines can leak when not properly closed.

• would be nice to be able to schedule them cron wise easily

Write out philosophy behind framework in wiki

Think about features that would be very useful and wouldn't be a hassle to deal with (both as a framework developer and a using developer)

Routing (with authenticated endpoints)

Create actual golang package

Standard middleware

Write missing tests