# realtimate

> An Atlas Realm Build Environment

Latest version **2.1.1** (published 2024-01-08) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install realtimate
pnpm add realtimate
yarn add realtimate
bun add realtimate
```

Provides the command `realtimate`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2024-01-08 |
| First published | 2023-08-14 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14 <=20 |
| Dependencies | 20 |
| Unpacked size | 89.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Les Fabricants |
| Maintainers | morgane7380274, benjamindequevauviller, augustin_b, coralie, julienlesfabricants, anthonyl_web |

## Links

- npm: https://www.npmjs.com/package/realtimate
- Repository: https://github.com/LesFabricants/realtimate
- Homepage: https://github.com/LesFabricants/realtimate#readme
- Issues: https://github.com/LesFabricants/realtimate/issues
- npm.io page: https://npm.io/package/realtimate

## Dependencies (20)

- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [ejson](https://npm.io/package/ejson.md) ^2.2.3
- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [figlet](https://npm.io/package/figlet.md) ^1.6.0
- [express](https://npm.io/package/express.md) ^4.18.2
- [mongodb](https://npm.io/package/mongodb.md) ^5.7.0
- [readline](https://npm.io/package/readline.md) ^1.3.0
- [commander](https://npm.io/package/commander.md) ^11.0.0
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.35
- [@vercel/ncc](https://npm.io/package/@vercel/ncc.md) ^0.36.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.20.2
- [@types/chalk](https://npm.io/package/@types/chalk.md) ^2.2.0
- [@types/figlet](https://npm.io/package/@types/figlet.md) ^1.5.6
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10
- [@types/express](https://npm.io/package/@types/express.md) ^4.17.17
- [@types/body-parser](https://npm.io/package/@types/body-parser.md) ^1.19.2
- [@types/readline-sync](https://npm.io/package/@types/readline-sync.md) ^1.4.4
- [mongodb-memory-server](https://npm.io/package/mongodb-memory-server.md) ^8.14.0
- [atlas-app-services-cli](https://npm.io/package/atlas-app-services-cli.md) ^1.0.3
- [typescript-source-graph](https://npm.io/package/typescript-source-graph.md) ^1.0.0

## Recent versions

- 2.1.1 (latest) — 2024-01-08
- 2.2.0-develop.7 (develop) — 2024-12-05
- 2.2.0-develop.6 — 2024-08-02
- 2.2.0-develop.5 — 2024-08-02
- 2.2.0-develop.4 — 2024-08-02
- 2.2.0-develop.3 — 2024-02-27
- 2.2.0-develop.2 — 2024-02-19
- 2.2.0-develop.1 — 2024-02-19
- 2.1.2-develop.1 — 2024-02-16
- 2.1.0 — 2023-12-12
- 2.1.0-develop.7 — 2023-12-12
- 2.1.0-develop.6 — 2023-12-08
- 2.1.0-develop.5 — 2023-11-30
- 2.1.0-develop.4 — 2023-11-30
- 2.1.0-develop.3 — 2023-11-30
- … 13 more at https://npm.io/package/realtimate/versions

## README

![Realtimate](misc/realtimate.svg?raw=true "Realtimate")

# Realtimate - Local Realm Atlas Environment Simulator

Realtimate is a command-line tool designed to facilitate the simulation of a local environment for MongoDB Realm on Atlas. This tool enables developers to test and debug their applications that utilize MongoDB Realm services without the need to interact with a live Atlas cluster. By creating a localized simulation of the Realm environment, developers can iterate faster, identify issues earlier, and ensure the reliability of their applications.

you can found examples in the `/examples` folder

## Installation

### On demand

Using `npx` you can run the script without installing it first:

```shell
npx realtimate [arguments]
```

### Globally via `npm`

```
npm install -g realtimate
```

## Usage

Once installed, you can use the `realtimate` command to manage and simulate your local Realm Atlas environment.

### Init your project

To start initialization, run :

```
realtimate init
```

This command initializes the project with minimum requirements and allows future deployments to realm atlas

### Create a local realm app

```bash
realtimate new <appName>
```

This will create a local realm app with the good tree. and a `src/<appName>` folder with the .ts files of your functions.

### Run

Finally, to simulate your app, just run

```bash
realtimate run
```

## Feedback and Contributions

We welcome feedback and contributions from the community. If you encounter issues, have suggestions, or want to contribute to Realtimate, please check out our [GitHub repository](https://github.com/your-username/realtimate) and open issues or pull requests.

## Development

Checkout this repository locally, then

```shell
npm i
npm run watch
```

## License

Realtimate is released under the [GNU GPL3](LICENSE).

---

Happy simulating with Realtimate! If you have any questions or need assistance, don't hesitate to reach out to us.

---
_Source: https://npm.io/package/realtimate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._