masqueradejs
Website
Github
Discord
Search…
MasqueradeJS
Getting Started
Installation
Configuration
Directory Structure
Concepts
Service Container
Service Providers
Contracts
Symbols
OCLIF
The Basics
Commands
Browsers
Acts
Scenes
Auditions
Database
Exceptions
Automation
Puppeteer
Playwright
Puppeteer-Extra
Advanced
Masks
Proxies
Validation
Templates
Hooks
Compiling
Packages
Using Packages
Composing Packages
Testing
Running Tests
Writing Tests
Mocking
API Documentation
Community
Contributing
Discord
Powered By
GitBook
Installation
Requirements
Before installing Masquerade, it's important to prepare your environment to enable the framework to run correctly.
Masquerade requires the following:
Node 14.0+
TypeScript 4.0+
Git 2.0+
To confirm your current versions you can run:
$
node
-v
# Should return: v14.x.x
$ tsc -v
# Should return: Version 4.x.x
$
git
--version
# Should return: git version 2.x.x
Installation
To install the Masquerade project skeleton, simply clone the repo into a new directory using one of the following commands.
# HTTPS
$
git
clone https://github.com/masqueradejs/masquerade
<
YOUR-PROJECT-NAME
>
# SSH
$
git
clone
[email protected]
:masqueradejs/masquerade.git
<
YOUR-PROJECT-NAME
>
# GitHub CLI
$ gh repo clone masqueradejs/masquerade
<
YOUR-PROJECT-NAME
>
Once the project has been cloned, navigate to the created project directory and install dependencies. Both
NPM
and
Yarn
package management are available but for the sake of simplicity, we will use
npm
syntax for the remainder of the documentation.
# Install dependencies
$
npm
install
# Run intitial setup tasks
$
npm
run init
Previous
MasqueradeJS
Next - Getting Started
Configuration
Last modified
1yr ago
Copy link
Outline
Requirements
Installation