https://github.com/tjtanjin/my-api
A collection of modules serving up utility APIs.
https://github.com/tjtanjin/my-api
api
Last synced: 7 months ago
JSON representation
A collection of modules serving up utility APIs.
- Host: GitHub
- URL: https://github.com/tjtanjin/my-api
- Owner: tjtanjin
- Created: 2023-05-26T09:50:57.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T14:54:34.000Z (about 1 year ago)
- Last Synced: 2024-09-05T20:21:23.811Z (about 1 year ago)
- Topics: api
- Language: TypeScript
- Homepage:
- Size: 200 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
My-API
## Table of Contents
* [Introduction](#introduction)
* [Features](#features)
* [Technologies](#technologies)
* [Setup](#setup)
* [Deployment](#deployment)
* [Team](#team)
* [Contributing](#contributing)
* [Others](#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](https://github.com/tjtanjin/simple-media-converter). To present it in the form of a custom [shield](https://shields.io), 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](https://github.com/tjtanjin/my-api/blob/master/docs/counter/UserGuide.md)
- [Aggregator](https://github.com/tjtanjin/my-api/blob/master/docs/aggregator/UserGuide.md)
### 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](https://github.com/tjtanjin)
### 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: cjtanjin@gmail.com.