FancyBox SDK

Description

FancyBox SDK written in Typescript

Table of Contents

- Getting started
- Build
- Deploy

Getting started

$3

You need to set up your development environment before you can do anything.

install latest 16.x NodeJS LTS version

Install Node.js and NPM (install latest 16.x LTS version)

- on OSX use homebrew brew install node
- on Windows use chocolatey choco install nodejs
- with nvm nvm install v16

Install yarn globally

``bash
yarn install yarn -g
`

> If you work with a mac, we recommend to use homebrew and nvm for the installation.

#### Husky commands

Create a file in ~/.huskyrc with the following command:


`
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
`

$3

Pull this repository then copy the ./config/configs.json.example file and rename it to ./config/configs.json.

edit this file with... TODO

$3

Go to the project dir and start your app with this yarn script.

`bash
yarn start:dev
`

> This starts a local server using nodemon, which will watch for any file changes and will restart the sever according to these changes.

$3

Go to the project dir and build your app with this yarn script.

`bash
yarn build
`

Publish on NPM (2FA required)

Add your npm token in the .npmrc file and then run the following command.
You will be asked for 2FA code.

`bash
npm publish ./
`

Run test script

`bash
NODE_ENV=development node -r ts-node/register ./scripts/test_script.ts
``