Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/czioutas/open-api-base
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.
https://github.com/czioutas/open-api-base
api backend backend-api nestjs open public
Last synced: about 4 hours ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/czioutas/open-api-base
- Owner: czioutas
- License: mit
- Created: 2023-08-28T14:40:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-12T18:49:21.000Z (over 1 year ago)
- Last Synced: 2023-10-14T18:25:52.317Z (over 1 year ago)
- Topics: api, backend, backend-api, nestjs, open, public
- Language: TypeScript
- Homepage: https://openapibase.com/
- Size: 1.89 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# ⚡ Open-API-Base [](https://github.com/czioutas/open-api-base/actions/workflows/ci.yml)
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 👉 [](https://wakatime.com/badge/github/czioutas/open-api-base)
_this does not include, build time, waiting for CI, googling, etc._
# Table of Contents
- [Steps](#steps)
- [Features](#features)
- [Technologies](#technologies)
- [Code README](core/README.md)
- [License](#license)
## 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](https://betterstack.com/) but you can switch to any provider)
- Authentication (MagicLink/Passwordless)
- Email Communication (The API uses [Sendgrid](https://sendgrid.com/) 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](https://open-api-base-documentation.pages.dev/documentation/)
### Technologies
- [Nestjs](https://nestjs.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [PostgreSQL](https://www.postgresql.org/)
- [Github Actions](https://github.com/features/actions)
- [Docker](https://www.docker.com/)
### License
This codebase is using the MIT License and therefore is available to be used however the actor decides.
A mention of this [repo](https://github.com/czioutas/open-api-base) or [myself](https://twitter.com/czioutas) would be greatly be appreciated. 🙇♂️
### More
You can follow the journey of development on twitter [here](https://twitter.com/czioutas/thread/1696242160536797467) and the blog posts [here](https://openapibase.com/blog/)