tjtanjin / my-api

A collection of modules serving up utility APIs.

My-API

Table of Contents

• Introduction
• Features
• Technologies
• Setup
• Deployment
• Team
• Contributing
• Others

Introduction

My-API is a collection of lightweight utility APIs that aims to address common use cases across projects. Organized into modules, users are given the flexibility to choose which feature they require. Module configurations are neatly handled within the .env file and clear user guides are written for each module. Motivation for this project arose from the need to have a counter API to share the number of files converted for another project of mine - Simple Media Converter. To present it in the form of a custom shield, yet another API endpoint was required. Hence the first two modules, Counter and Aggregator were created. I hope to expand on this project in the near future with the possibility of supporting more storage options as well as additional modules such as FileHosting.

Features

My-API currently has 2 modules available. For more information on each of these modules and what they do, please refer to their respective user guides (linked below):

• Counter
• Aggregator

Technologies

Technologies used by My-API are as below:

Done with:

TypeScript

MySQL

Project Repository

https://github.com/tjtanjin/my-api

Setup

to be updated

Deployment

to be updated

Team

• Tan Jin

Contributing

If you have code to contribute to the project, open a pull request and describe clearly the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply raise bugs or suggestions by opening an issue.

Others

For any questions regarding the implementation of the project, please drop an email to: [email protected].