Quick Start
Step 1. Install Node
To check if NodeJS is already installed, open a terminal, type in node, and hit enter. If you see "Welcome to Node.js" you can skip this step. We recommend Node v20+
Download and install NodeJS from https://nodejs.org/en/download. NodeJS includes NPM.
Step 2. Install the Moopsy Devtools Globally
Install the Moopsy devtools:
npm i -g @moopsyjs/devtools
Local MongoDB
If you want to run MongoDB locally, install MongoDB and add "withLocalMongo": true to your moopsy.json file.
Local Redis
If you want to run Redis locally, install Redis and add "withLocalRedis": true to your moopsy.json file.
Step 3. Clone the Moopsy boilerplate
The latest boilerplate is available at https://github.com/moopsyjs/boilerplate. Clone it!
Step 4. Run the app
cd into the root directory (the one that contains frontend, backend, and common) and run:
npx moopsy start
This command will install frontend and backend dependencies, bundle the common files, start a local mongo server, and run the frontend and backend.
You can now access the local example app (a simple local todos app) at http://localhost:3000.