https://github.com/munaibh/hot-men

An un-opinionated boilerplate. This package will provide a smooth experience for both the front and backend.
https://github.com/munaibh/hot-men

actions boilerplate docker express heroku hot-reload mongodb nodejs webpack

Last synced: about 2 months ago
JSON representation

An un-opinionated boilerplate. This package will provide a smooth experience for both the front and backend.

• Host: GitHub
• URL: https://github.com/munaibh/hot-men
• Owner: munaibh
• License: apache-2.0
• Created: 2020-03-12T19:21:03.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T09:52:08.000Z (about 2 years ago)
• Last Synced: 2023-02-28T16:41:07.795Z (almost 2 years ago)
• Topics: actions, boilerplate, docker, express, heroku, hot-reload, mongodb, nodejs, webpack
• Language: JavaScript
• Homepage: https://hot-men-prod.herokuapp.com/
• Size: 977 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Hot MEN




  

  

  

  





  An un-opinionated boilerplate. This package will provide a smooth experience for both the front and backend.


  (PRs for better names are welcome!)






## ❯ Getting started

All you need is this repository, so just clone it to generate your project boilerplate.

```bash

$ git clone [email protected]:whatever my-awesome-project

$ cd my-awesome-project

```

## ❯ Usage

There are a couple of commands we want to keep an eye on when developing and building for production, these are listed below:

### Development

| Command           | Description |

| ---------------- | --- |

| `npm run serve`  | Starts up and a development server using webpack to watch the files. |

| `npm run debug`  | This command does the same as the `serve` command, however, it launches the server with the node `inspect` feature. |

| `npm run clean`  | This removes any extraneous files in the public directory along with removing the build directory. |

ℹ These development commands launch the client and server side code using Webpacks HMR. The views are automatically hard refreshed.

### Production

| Command           | Description |

| ---------------- | --- |

| `npm run start`  | Starts the application using the built files. |

| `npm run build`  | Creates a production build of the client and server and outputs them in `public` and `build` respectively. |

ℹ The production build commands are required before the server can be launched.

## ❯ But... Why?

Google said there were better ways than Nodemon! So I went huntin', but alas, I didn't find a boilerplate to match my needs, so I made one. A couple of things we provide include:

* Allows use of ES2018 and SASS.

* Hot Module Reloading (Client and Server).

* Refresh `views` on change.

* Production hashing of assets.

* Manifest generation in production.

* Inject version and manifest into Service Worker.

* Access manifest using `asset` function.






  Enjoy! 🤙