Pre-requisites

• Git
• Node.js
• yarn

Getting Started

# Create Shinobi App
$ npx @enginite/create-app myApp @enginite/shinobi
# The above command will generate a shinobi project with the files you need for App development

# Go into the repository
$ cd myApp

# Install dependencies
$ yarn

After your project is generated the following commands will be available

yarn dev or npm start

Runs your application at localhost:3000 with HMR enabled, which will automatically make changes to your application with reloading your browser.

yarn build or npm run build

This will generate a build folder with application ready to start at production server

node build/server.js

This will run your built application at port 3000, to run on specified port run with PORT=8080 node build/server.js.

FAQs

HMR not working?...

Try increasing watchers

$ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p