https://github.com/yuvalherziger/mdb-playground

Sample web project with MongoDB Atlas
https://github.com/yuvalherziger/mdb-playground

Last synced: 9 days ago
JSON representation

Sample web project with MongoDB Atlas

• Host: GitHub
• URL: https://github.com/yuvalherziger/mdb-playground
• Owner: yuvalherziger
• Created: 2024-07-26T08:13:45.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-26T08:50:32.000Z (4 months ago)
• Last Synced: 2024-10-31T18:12:24.726Z (16 days ago)
• Language: TypeScript
• Size: 39.1 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MongoDB Web Project Playground

## Installation

Note: this project was tested on Node.js versio 22.4.x. 

```shell

npm i

```

## Configuration

```shell

cat < .env

PORT=3000

MONGODB_URI=""

PRODUCTION=0

LOG_LEVEL=info

ATLAS_API_BASE_URI=https://cloud.mongodb.com/api/atlas/v2/groups//clusters//

ATLAS_PUBLIC_KEY=

ATLAS_PRIVATE_KEY=

EOF

```

## Run the web service

Run a development server with a change listener (nodemon):

```shell

npm run dev 

```

Build and run the project

```shell

npm run build

npm run start

```

Build and run in cluster mode:

```shell

npm run build

npm run prod

```

## Migrations

Create a migration in the following way:

```shell

npm run build-and-generate-migration --name=

```

This will create a new migration file under `./src/migrations/`.  If you named your migration "JIRA-214", you should see

a log entry along the following one:

```json

{

  "level":"info",

  "message":"Migration successfully written to /workspace/mdb-playground/src/migrations/m-20240726T083627-66a3600b6b350f3ede3d0010-JIRA-214.ts. Edit this TS file to implement the migration",

  "pid":"53697",

  "timestamp":"2024-07-26T08:36:27.776Z"

}

```

Once you finished editing your migration file (or files), you can apply it in the following way: 

```shell

npm run build-and-migration

```

This project contains a couple of sample migrations - you can try them out.