# cryptosheets

> Cryptosheets monorepo setup utilizing Yarn Workspaces, Lerna, Docker, and Azure.

Latest version **0.0.2** (published 2019-11-11) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-11-11 |
| First published | 2019-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 3.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | johnatspreadstreet |

## Links

- npm: https://www.npmjs.com/package/cryptosheets
- npm.io page: https://npm.io/package/cryptosheets

## Dependencies (5)

- [nps](https://npm.io/package/nps.md) ^5.9.8
- [lerna](https://npm.io/package/lerna.md) ^3.16.4
- [nps-i](https://npm.io/package/nps-i.md) ^1.0.2
- [cross-env](https://npm.io/package/cross-env.md) ^6.0.3
- [nps-utils](https://npm.io/package/nps-utils.md) ^1.7.0

## Recent versions

- 0.0.2 (latest) — 2019-11-11

## README

# Cryptosheets

Cryptosheets monorepo setup utilizing Yarn Workspaces, Lerna, Docker, and Azure.

## Prerequisites

1. Yarn - NPM package manager replacement
2. Lerna - link dependencies between packages
3. Docker - Containerized deployments [Link][https://docs.docker.com/docker-for-windows/install/]
4. Azure CLI - Commands to push to Azure Container Registry (ACR) and Azure App Service [Link][https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-windows?view=azure-cli-latest]

```
npm i -g yarn lerna
```

## Install

```
yarn bootstrap
```

The bootstrap command utilizes Lerna, and completes the following actions:

1. Runs a `prepare` script inside any packages that contain a prepare.
2. Installs all required modules in parallel, and hoists to the root level

## `yarn i`

Brings up the interactive scripts runner for all commands inside of terminal. See `package-scripts.js` for explanations of all scripts

## Resources

### Terminology

**Environments**

- Local: Runs application from computer at localhost:`port`. Ex. http://localhost:3000
- Dev/development: Runs application in development mode. Unoptimized. Typically contains enhanced debugging features
- Staging: Pushes application and builds application to prepare for transition to `dev` or `prod` server
- Production: Runs application in production mode. Uses advanced techniques such as compression. For an example, see https://expressjs.com/en/advanced/best-practice-performance.html

**Environment Methods**

- Dev: Starts application in development environment, typically localhost
- Build: Runs application through build process
- Deploy: Deploys build application to production environment 
  
### Environment Variables (.env)

.env files can be downloaded from the following url: TBD

### Building a Gatsby theme

https://www.gatsbyjs.org/tutorial/building-a-theme/#set-up-gatsby-theme-events-and-site

### Adding packages to themes

1. Add dependencies to site: `yarn workspace <site> add <dependency>`
2. Add dependencies to theme: `yarn workspace <theme> add <dependency>`

### Changing Ant Design variables

**Theme Documentation**
https://ant.design/docs/react/customize-theme

**Raw Variables**
https://github.com/ant-design/ant-design/blob/master/components/style/themes/default.less

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