Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sombriks/simple-knex-koa-example
sample application touring API, tests, continuous integration, continuous deployments, image publishing and so on
https://github.com/sombriks/simple-knex-koa-example
argocd docker docker-compose dotenv-flow github-actions gitops knex koa kubernetes migrations mocha node sinon sqlite
Last synced: about 1 month ago
JSON representation
sample application touring API, tests, continuous integration, continuous deployments, image publishing and so on
- Host: GitHub
- URL: https://github.com/sombriks/simple-knex-koa-example
- Owner: sombriks
- License: mit
- Created: 2023-02-26T18:09:10.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-12-16T15:27:31.000Z (11 months ago)
- Last Synced: 2024-10-01T02:04:45.185Z (about 2 months ago)
- Topics: argocd, docker, docker-compose, dotenv-flow, github-actions, gitops, knex, koa, kubernetes, migrations, mocha, node, sinon, sqlite
- Language: JavaScript
- Homepage: http://example.sombriks.org/books
- Size: 592 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [simple knex koa example](https://github.com/sombriks/simple-knex-koa-example)
[](https://github.com/sombriks/simple-knex-koa-example/actions)
[](https://hub.docker.com/r/sombriks/simple-knex-koa-example/tags)
sample application for [this blog post](https://sombriks.com/blog/0043-knex-still-rocks-on-modern-node/)
and for [this one too](https://sombriks.com/blog/0055-containers-part-3-app-container-friendly/)
## This is a project template
If starting a backend node project with [koa](https://koajs.com), consider
either use this template directly or just grab some inspiration.
## Requirements
- node 18
If you plan to run in production mode
- postgresql
If you plan to create a docker image container
- docker
See the `infrastructure` folder for further details.
If you plan to deploy the image into a kubernetes cluster, there are several
options, but try to set up [kind](https://kind.sigs.k8s.io/), since you already
had to setup docker.
## How to run this application
There are several ways to run this app:
### Bare metal
Install node dependencies and run the project:
```bash
npm install
npm run dev
```
### Docker
Create an image:
```bash
docker build -f infrastructure/Dockerfile \
-t sombriks/simple-knex-koa-example:development .
```
Then spin up a container:
```bash
docker run -it \
-e NODE_ENV=development \
-e PORT=3000 \
-p 3000:3000 sombriks/simple-knex-koa-example:development
```
### Docker compose
Create the image as shown in the previous section, then spin up
[the provided docker compose example file](infrastructure/docker-compose.yml):
```bash
NODE_ENV=development docker compose -f infrastructure/docker-compose.yml up
```
In all examples above, the app will start in `development mode`.
### Kubernetes
See the details [here](infrastructure/README.md).
## The articles
As mentioned in the beginning of this document, this source code was used to
offer support for a blog post. Eventually other articles came.
### [knex rocks](https://sombriks.com/blog/0043-knex-still-rocks-on-modern-node/)
Knex will help you to build your queries and that's it, no ORM, M-N relations,
nothing. it does only one thing and does it well.
### [containers, images, registries and so on](https://sombriks.com/blog/0055-containers-part-3-app-container-friendly/)
At some point container images became the de-facto standard for application
publishing and there is no way back from there.
but this is not a bad thing, once you figure out that good practices still
mostly the same.
### [Testing kubernetes configurations with kind](https://sombriks.com/blog/0058-containers-part-4-k8s-with-kind/)
Kubernetes is how people put things in production nowadays and sometimes
it can be tricky to test because it's heavy.
By using kind as kubernetes runtime, part of this issue is solved and the
developer can be more confident on how the application will behave inside
the belly of the beast.
### [The GitHub Actions playground](https://sombriks.com/blog/0061-github-actions-recipes/)
GitHub Actions can be a very handy too to implement continuous Integration,
Continuous Delivery and Continuous Deployment.
I built some simple, useless yet educational examples so when building more
complex workflows this material could be consulted.
It was key to build [this good enough example](.github/workflows/_base.yml) of
deployment workflow base for GitOps pull based solutions combined with
[ArgoCD](https://argo-cd.readthedocs.io/en/stable/getting_started/).
## References
- [node](https://nodejs.org)
- [knex](https://knexjs.org)
- [sqlite](https://sqlite.org)
- [postgresql](https://postgresql.org)
- [koa](https://koajs.com)
- [docker](https://docker.com)
- [kind](https://kind.sigs.k8s.io/)
- [github actions recipes](https://github.com/sombriks/gh-actions-playground)