API-template

What is it ?

The purpose of this template is to provide a typesafe, production ready web API, and a full development environment with the best tooling possible

It gives your project a clean base to start and follows development good practices, essentially focusing on maintenability and extensibility

Lastly, it aims to save developers a lot of time since all nasty configurations are already written (typescript, eslint, jest, docker, CI, ...) and technologies are already chosen (language, testing framework, database, ORM, ...)

API-template is fully integrated with - front-template, a modern typescript frontend stack - ops-template, a complete scalable infrastructure on Kubernetes

Don't hesitate to share your improvements or to give feedback on Discord (LeChatErrant#6074) :wink:

This repository is templated. Use it as a base for your own projects by clicking on Use this template

Table of contents

• Documentation
• Deployment
• Getting started
• Technologies
• CLI
• Work in progress
• How to contribute
• Contributors

Documentation

Documentation can be found in the wiki

Deployment

API is deployed on Heroku and can be reached on api-template-prod.herokuapp.com

Additionally, a public Postman workspace is available on www.postman.com/LeChatErrant/workspace/api-template to let you try the API

For a complete production deployment, see ops-template

Getting started

1. Make sure the .envrc is loaded (have a look here)
2. Install dependencies with npm install
3. Launch a local database with npm run dev:db
4. Run npm run dev

Technologies

• Typescript : Language
• Express : Web server
• Heroku : Application hosting
• Prisma : ORM
• Prisma studio : Database visualisation
• Prisma migrate : Database migration
• Prisma data platform : Database hosting
• Bcrypt : Password hashing
• Eslint : Code styling
• Jest : Testing
• Supertest : Endpoint testing
• Class validator : DTO validation
• Winston : Logger
• Husky : Pre commit hooks
• Github action : CI / CD
• Docker : Containerization
• Redis : Session management
• PostgreSQL : Database

...and more

CLI

The template comes with a Command-Line Interface that helps you to initialize, develop and maintain your projects. It saves you from writing boilerplate code

The CLI is currently under heavy development, new features will be release soon ❤️

More details in wiki

Work in progress

• [ ] CLI to create, extend and manage API resources
• [ ] Auto generated code documentation
• [ ] Integration with Prisma seeders
• [ ] Back office template

How to contribute

1. Fork it (https://github.com/LeChatErrant/API-template/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Issues and comments welcomed ! :wink:

Contributors

  LeChatErrant - creator and maintainer