mhaidarhanif / super-workshop-js

⚙️ Super Workshop JS. Workshop with various JavaScript and Node.js technologies.

Super Workshop JS ⚙️ Workshop with JavaScript

Table of Contents

• Why?
• What?
• How?
• Hall of Badges
  • General
  • Server with Node.js and Express
• Hall of Requirements
• Hall of Technologies
• Hall of Development
  • Server Express (server-express)
  • Client jQuery (client-jquery)
  • Test Chai (test-chai)
• Hall of Deployment
  • Local Check => Deploy to Cloud
  • Integration Check
• Hall of References
• License

Why?

"Tell me and I forget. Teach me and I remember. Involve me and I learn." — Benjamin Franklin

To engage and involve people who want to learn and collaborate together.

What?

This experimental workshop repo is intended as a fuondation and designed for faster learning curve of practicing, implementing, and teaching friendly best practice of various web technologies.

How?

By telling and teaching directly to learners in the most simple and interactive fashion. As we want to actualize good ideas, architectures, and infrastructures of RESTful web application.

---

Hall of Badges

General

Category	Badge
Website
Management
License
Style Guide
Dependency CI
bitHound
bitHound Dep
Codacy Grade
Code Climate
Travis CI
Snap CI	[]
Codeship
Inch CI Docs

Server with Node.js and Express

Category	Badge
Node.js
npm
Dependency
Dev Dependency
Express
Coverage
Security

---

Hall of Requirements

• Engineering software the right way
• Understanding the essentials of JavaScript and Node.js
• Concepts of client & server side
• Technologies of database & deployment pipeline

---

Hall of Technologies

See the Tech Stack, Technical Keywords, and Programming Languages

---

Hall of Development

Make sure you have installed the latest Node.js and npm. Afterwards, install the required global dependencies.

# node modules
npm install -g yarn pnpm pm2 nodemon mocha karma-cli live-server bower vue-cli react-native-cli

# ruby gems
sudo gem install travis

Then open these directories separately, based on your own preference:

• servers/server-*
• clients/client-*
• tests/test-*

Server Express (server-express)

npm install
./bootstrap.sh # will copy config/*.schema.js to their own config/*.js
# edit each config/*.js
npm run start:dev

Client jQuery (client-jquery)

bower install
live-server

Test Chai (test-chai)

yarn
# edit .env
npm test
travis login --auto

---

Hall of Deployment

(Later, define usage of CI/CD with Codeship or Snap CI)

Local Check => Deploy to Cloud

Server

cd servers/server-x
npm start
pm2 list

Client

cd clients/client-x
npm start
# open browser

Test

cd tests/test-x
npm test

Deploy

npm run deploy:dev:setup
npm run deploy:dev

Integration Check

git push origin master
# open https://travis-ci.org/mhaidarh/super-workshop-js

---

Hall of References

• JavaScript
• Node.js
• Cloud9 Workspace

---

License

Verbatim copy of MIT License

Copyright (c) 2017 M Haidar Hanif, https://mhaidarhanif.com

super-workshop-js's Issues

Must contain list

• Terminal
• Shell Alias
• Shell Environment
• Editor + Browser Extension
• Git Commit
• Git Branch
  • Git Flow
• README
• API Spec
  • API Blueprint
  • Swagger
  • RAML
• Servers
  • package.json
  • Express MVC API
  • PM2
• Clients
  • jQuery
  • Vue
• Linting/Hinting
  • ESLint + Standard
  • bitHound
  • Codacy
  • Code Climate
• Tests
  • Mocha + Chai + Chai HTTP
  • Istanbul + Code Climate Coverage
• Agile
  • Scrum + Kanban
  • GitHub Projects / Waffle / ZenHub / Trello

Separate repos into their own purpose

🎓 Let's graduate the repos (server/client/test) that has been stable, could be treated as gitmodules later. Make sure the repo and service orchestration is still centralized in this repo.

Create a branding and logo design

Create a branding and logo design that enhance the looks of this repo.