Skip to content

This repository contains a free API written, with the aim to provide a fully fledged API system that can support your project from start to thousands of users/calls etc without the need of external services except infrastructure components such as Databases, Cache layers, Mailing systems etc.

License

Notifications You must be signed in to change notification settings

czioutas/open-api-base

Repository files navigation

⚡ Open-API-Base API CI

This repository contains a free API written, with the aim to provide a fully fledged API system that can support your project from start to thousands of users/calls etc without the need of external services except infrastructure components such as Databases, Cache layers, Mailing systems etc.

Why?

This API is built upon a decade plus of experience. In addition we are real time capturing the active coding hours using wakatime which you can see 👉 wakatime

this does not include, build time, waiting for CI, googling, etc.

Table of Contents

Steps

  • copy repo
  • rename namespace if you prefer
  • adapt the .env file with any service you wish to use
  • enable the CI/CD pipelines based on your needs
  • run it on your cloud of choice either as raw code or container

Features

  • Configuration (via .env files) used by DI
  • Logging (The API uses Logtail but you can switch to any provider)
  • Authentication (MagicLink/Passwordless)
  • Email Communication (The API uses Sendgrid but you can switch to any provider)
  • Exception handling
  • Health Checks endpoint (Quick or Database check as minimum)
  • Cloud Storage (S3 compatible)
  • Swagger API
  • Auto generated Documentation see Demo documentation

Technologies

License

This codebase is using the MIT License and therefore is available to be used however the actor decides. A mention of this repo or myself would be greatly be appreciated. 🙇‍♂️

More

You can follow the journey of development on twitter here and the blog posts here

About

This repository contains a free API written, with the aim to provide a fully fledged API system that can support your project from start to thousands of users/calls etc without the need of external services except infrastructure components such as Databases, Cache layers, Mailing systems etc.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published