lechaterrant/api-template

Modern production-ready typescript backend template

Hi there 👋

---

Hi, I'm LeChatErrant !

• 🔭 I’m currently working on Back-end architecture, Typescript, Kubernetes and Cloud-computing design pattern
• 🌱 I’m currently learning Front-end, with React and NextJS
• 📫 You can reach me on :
  • Discord : LeChatErrant#6074
  • Email : [email protected]

---

api-template's Issues

Conditionnal pre-commit script

Actual behaviour

Husky is used to bind pre-commit scripts
Linter and prisma:format are applied with each commit

Expected behaviour

Linter should only be executed on modified+commited files
prisma:format should only be executed if needed

Remove Husky hooks

Feature Request

Husky pre-commit hooks should be removed

Actual behaviour

Every files are linted before each commits, even if not touched

It is more time consuming than expected and only annoy developers

It often lead to confusion in commits when an error occurs, and pipelines are already checking code integrity

Expected behaviour

Pre commit hooks should simply be deleted

Cli upgrade

Cli should be upgraded to version 3.0.0, featuring :

• Better display
• Multiple bugs fixed
• Full API resource templating, enabling to build directly after generating new code without adding any changes

Generating resource using CLI

The process of generating new API resource using the CLI should be documented in the wiki

Prisma seeder

Currently, database seeding is written inside the app, and executed at launch time

With Prisma v1.19 release, it is now possible to create seeders, and the seeding logic should be migrated to this new mechanism

Moving CLI to a standalone NPM package

Currently, the CLI is maintained inside the project

It shall be moved to a standalone npm package, to

• be developed and maintained independently from the project
• be used across multiple projects
• not interact with project dependencies
• be used to init a new project

Prisma engine not terminated after integration

After running integration tests, Prisma Engine should be correctly terminated

Currently, it stays as an orphan process and ends up consuming resource

Generate changelog from issues on release creation

Release creation has been automated thanks to GitHub actions

A new release can be created under Actions -> Create new release -> Run workflow
Changelog, based on repository data such as issue, should be autogenerated