https://github.com/kentlouisetonino/node-integration

A Node.js backend playground that integrates with different technologies.
https://github.com/kentlouisetonino/node-integration

aws-s3 backend expressjs jest mongodb multer nodejs openai-chatgpt restful-api typescript unit-test

Last synced: 4 months ago
JSON representation

A Node.js backend playground that integrates with different technologies.

Host: GitHub
URL: https://github.com/kentlouisetonino/node-integration
Owner: kentlouisetonino
License: mit
Created: 2024-03-13T12:13:20.000Z (about 1 year ago)
Default Branch: develop
Last Pushed: 2024-04-12T04:04:02.000Z (about 1 year ago)
Last Synced: 2024-04-12T12:03:31.150Z (about 1 year ago)
Topics: aws-s3, backend, expressjs, jest, mongodb, multer, nodejs, openai-chatgpt, restful-api, typescript, unit-test
Language: TypeScript
Homepage:
Size: 1.16 MB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

README

### Description
#
> - A backend server that integrates with different technologies.

> - This will serves as my playground in `Node.js` backend development.

> - Check the project [docs](https://github.com/kentlouisetonino/node-backend/tree/develop/docs) for further guides.

> - Below are the current supported routes.

```bash
# Root URL of the backend server.
http://localhost:11000/api

# This includes the integration of AWS S3 service.
/aws/s3/upload
/aws/s3/delete
/aws/s3/url

# This includes the integration OpenAI Chat GPT.
/openai/chat

# This includes the integration of MongoDB.
/mongodb/create/collection
/mongodb/create/document
```

### System Design
#

![Screenshot from 2024-03-19 20-01-58](https://github.com/kentlouisetonino/node-backend/assets/69438999/55747c89-94e4-4098-b04b-b4c7986cd24b)

### Local Development
#
> - This works well with `Node.js version >= 18`.

> - Run the following commands.

```bash
# Development
yarn install
yarn build
yarn dev

# Unit Test
yarn test:all
```