# mrm-preset-nearform

> An mrm tasks preset for setting up a NearForm template repository

Latest version **1.2.0** (published 2022-03-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install mrm-preset-nearform
pnpm add mrm-preset-nearform
yarn add mrm-preset-nearform
bun add mrm-preset-nearform
```

## 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 | 1.2.0 |
| Published | 2022-03-11 |
| First published | 2022-02-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 43.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | NearForm |
| Maintainers | sameer13, radomird, rafaelgss, jimmymintzer, shogun_panda, nearformer, matteo.collina, simoneb, irelandm, eamonn.frisby |

## Links

- npm: https://www.npmjs.com/package/mrm-preset-nearform
- Repository: https://github.com/nearform/mrm-preset-nearform
- Homepage: https://github.com/nearform/mrm-preset-nearform#readme
- Issues: https://github.com/nearform/mrm-preset-nearform/issues
- npm.io page: https://npm.io/package/mrm-preset-nearform

## Dependencies (1)

- [mrm-core](https://npm.io/package/mrm-core.md) ^6.1.7

## Recent versions

- 1.2.0 (latest) — 2022-03-11
- 1.1.1 — 2022-02-28
- 1.0.2 — 2022-02-11

## README

# NearForm MRM Preset

[![Continuous Integration](https://github.com/nearform/mrm-preset-nearform/actions/workflows/ci.yml/badge.svg)](https://github.com/nearform/mrm-preset-nearform/actions/workflows/ci.yml)
[![NPM version](https://img.shields.io/npm/v/mrm-preset-nearform)](https://www.npmjs.com/package/mrm-preset-nearform)

This a tasks preset for the [mrm](https://mrm.js.org/) library, used to transform a repository
into one of the following: 

1. `GitHub Action` project, by adding the following features:
    - an automatic GitHub release action
    - bundling on commit, set up with [@vercel/ncc](https://github.com/vercel/ncc)
    - tests with [jest](https://jestjs.io/) along with necessary linting changes and transpilation setup
2. `Fastify Plugin` Fastify plugin
    - bundling on commit, set up with [@vercel/ncc](https://github.com/vercel/ncc)
    - tests with [jest](https://jestjs.io/)
3. `Fastify Application` it adds the following features:
    - tests with [tap](https://github.com/tapjs/node-tap)
    - it uses [fastify-cli](https://github.com/fastify/fastify-cli) to run a non-standalone application
4. `Aws CDK` aws cdk project
    - it uses [aws-cdk-lib](https://aws.amazon.com/cdk/) to define AWS resources using code.
    - tests with [tap](https://github.com/tapjs/node-tap)

## Using this task
Simply run the following command in your project's root:

```shell
npx mrm $TASK_NAME --preset nearform --interactive
```

Where `$TASK_NAME` is one of the following: 
1. `github-action`.
2. `fastify-plugin`
3. `fastify-app`
4. `aws-cdk`


If this is the first time you're using `mrm` you will be asked for permission to install it, and the interactive setup 
will begin.

## Development
Assuming that the repository you're setting up is checked out next to this project, e.g.:
```
Users
  yourusername
    mrm-preset-nearform
    your-repository
```
and that your current working directory is:
```
/Users/yourusername/your-repository
```

the easiest way to test the local version of this task is to reference it directly from the file system:

```shell
npx mrm $TASK_NAME --preset ${PWD}/../mrm-preset-nearform --interactive
```

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