A Simple CRUD App Starter, built with FeathersJS and VueJS

The purpose of Cruddy is to provide re-usable solutions for common problems that occur in Client / Server Realtime Applications.

git clone https://github.com/elog08/Cruddy.git;
cd Cruddy/;

If using Node Version Manager

cd scripts && sh pre-check.sh && cd ../;

else, elevate to sudo privilege

cd scripts && sudo sh pre-check.sh && cd ../;

Install and test dependencies

cd scripts && sh test-dependencies.sh && cd ../;

Launch

pm2 start ecosystem.config.js;
pm2 logs;

If all goes well, it should start 2 servers.

The Client Server listens on 0.0.0.0:8080 The API Server listens on 0.0.0.0:8081

Go to http://localhost:8080/ to access the App. You will also be able to access the API from within the client using http://localhost:8080/api/. This prevents annoying CORS issues.

• Node 8+
• MacOS or Linux (not tested on Win)

Run the pre-check script

cd scripts && sh pre-check.sh

or

Install the following global tools:

npm install -g @feathersjs/cli @vue/cli pm2

To make sure you have all the right libs to run the stack, run the following script:

cd scripts && sh test-dependencies.sh

pm2 start ecosystem.config.js 

This will start:

• A Webpack Dev Server with Hot Reload on Port 8080 (proxies /api to FeathersJS)
• A FeatherJS instance on Port 8081 that is agnostic of the /api base

For testing the prod environment in a low-traffic setting

pm2 start ecosystem.config.js --env=production

This will start:

• A Simple Express Static File Server on Port 8080 and an API Proxy to Feathers
• A FeatherJS instance on Port 8081

Use Nginx to serve the static files and Proxy-pass /api to a PM2 cluster running the server.

Build your own image.

docker build -t yourhandle/cruddy .

Run

docker run -p 80:80 yourhandle/cruddy

• TODO: Optimize Docker build
• TODO: Nginx.conf example