Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ezralazuardy/you-api
A sample of You App RESTful API.
https://github.com/ezralazuardy/you-api
docker fastify mongo nest rabbitmq swc typescript
Last synced: 4 days ago
JSON representation
A sample of You App RESTful API.
- Host: GitHub
- URL: https://github.com/ezralazuardy/you-api
- Owner: ezralazuardy
- Created: 2024-06-24T17:09:08.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-02T11:38:21.000Z (6 months ago)
- Last Synced: 2024-11-09T20:43:39.796Z (about 2 months ago)
- Topics: docker, fastify, mongo, nest, rabbitmq, swc, typescript
- Language: TypeScript
- Homepage: https://you-api.koyeb.app
- Size: 1.07 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
## 🛰️ you-api
**🔗 Endpoint:** https://you-api.koyeb.app
**📘 Documentation:** [Postman](https://www.postman.com/speeding-shadow-723699/workspace/you-api)
**📕 Technical Documentation:** [Notion](https://sky-cicada-919.notion.site/Technical-Documentation-You-App-RESTful-API-483f67d0d6994c50ae8210b8804df8e5)
This is a sample of You App RESTful API.
This instance is the core of RESTful API platform and meant to be directly consumed on the frontend.
![image](https://github.com/ezralazuardy/you-api/assets/24422019/8141330f-80df-4cf3-84a9-db861bc0569d)
### ⚙️ Features
| Module | Description | Supported |
|---------------- |------------------------------------------------------- |----------- |
| Authentication | Endpoints for authentication and registration features | ✅ |
| Message | Endpoints for messaging or chatting features | ✅ |
| Profile | Endpoint for managing user profile data | ✅ |
| Health | Endpoints for checking the server health | ✅ |
> Written in [Typescript](https://www.typescriptlang.org) using [Nest](https://nestjs.com). Powered by [Docker](https://docker.com) and [Koyeb](https://koyeb.com).
> #### Disclaimer
>
> This project is intended for Coding Test at You App.
>
> This project is **NOT** licensed and all rights are reserved.
>
You are not allowed to use this project for commercial
> purposes.
>
You are allowed to use this project for educational purposes.