https://github.com/asadhasan/express-mongo-kubernetes

Basic Express service with MongoDB, deployed on Kubernetes.
https://github.com/asadhasan/express-mongo-kubernetes

axios buildpack codeql dependabot docker-compose eslint express github-actions helm kubernetes minikube mongodb mongoose multistage-docker nodejs npm okteto ts-jest tsc typescript

Last synced: 7 days ago
JSON representation

Basic Express service with MongoDB, deployed on Kubernetes.

• Host: GitHub
• URL: https://github.com/asadhasan/express-mongo-kubernetes
• Owner: AsadHasan
• License: mit
• Created: 2021-09-10T17:25:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T08:28:19.000Z (2 months ago)
• Last Synced: 2024-10-28T07:30:43.503Z (about 2 months ago)
• Topics: axios, buildpack, codeql, dependabot, docker-compose, eslint, express, github-actions, helm, kubernetes, minikube, mongodb, mongoose, multistage-docker, nodejs, npm, okteto, ts-jest, tsc, typescript
• Language: TypeScript
• Homepage:
• Size: 1.81 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Express Mongo Service

A basic API, built using [Express](https://expressjs.com/) server and [MongoDB](https://www.mongodb.com/) database (with [Mongoose](https://mongoosejs.com/) ORM), bootstrapped using [Google Typescript Style-guide](https://github.com/google/gts). It contains following endpoints:

1. `GET /testcases`: Returns list of existing test cases.

2. `POST /test-case`: Creates a test case, based on following request body:

```

{

    "name": string,

    "summary": string,

    "description": string

}

```

## To deploy and run

Use either of following 2 options:

1. [`Docker-compose`](https://docs.docker.com/compose/) (for local dev): Run `docker-compose run --rm express` (requires `docker-compose`)

2. [`Kubernetes`](https://kubernetes.io/) (Requires [`Helm`](https://helm.sh) and an available Kubernetes cluster):

   1. Package a Helm chart: `helm package helm/ -d charts/` (creates chart in new `./charts` directory)

   2. Install the Helm chart: `helm install express-mongo-release charts/express-mongo-0.0.1.tgz` (creates Helm release `express-mongo-release` on available cluster. Caveat: Have tested this _only_ on [`minikube`](https://minikube.sigs.k8s.io/docs/) locally, _not_ on _any_ cloud (AWS, GCP etc) cluster!)

## Testing

Basic end-to-end tests exist in `tests` folder, that can be run via the `npm run e2e-tests` script (requires `docker-compose`). Tests call the API via [`Axios`](https://axios-http.com/) and run via [`ts-jest`](https://github.com/kulshekhar/ts-jest).

## CI

Docker image and Helm chart being published via [GitHub Actions](https://github.com/actions).

## Issues

`Helm` chart has been created (via [Kompose](https://kompose.io/)). It can be packaged and installed on `Kubernetes`, however Mongo does not store data in a persistent volume or similar.