• Overview 👀

  • Why ?

    ..

  • When ?

    ..

  
  
  

• Quick Start 🔥

  install hmm first.

  • Create

    > hmm init <name> -t server # This will clone this repo and make some changes to suit your server.
    > cd <name>                 # Go to the project directory
    > hmm install               # Install the dependencies

  • Manage

    > hmm build                 # To build your server
    > hmm test                  # To test  your server
    > hmm start                 # To start your server

    # example
        > hmm start
    
    # output
        16:16:31 ✓ Server started at http://localhost:3000
        16:17:25 GET / 200 4ms
        ...

  
  
  

  • ..

    ..

  • ..

    ..

  
  
  

• Documentation 📑

  • Structure

    • Root

      ┣ assets
      ┃ ┗ ...             #  (logo.png, ..)
      ┃
      ┣ dist
      ┃ ┗ ...             # (index.js, index.js.map, ..)
      ┃
      ┣ src
      ┃ ┗ index.ts        # Main entry point
      ┃
      ┣ test
      ┃ ┗ index.test.ts   # Main test file
      ┃
      ┣ .env               # Environment configuration file
      ┗ .hmm               # hmm configuration file
      
      # You can safely hide/ignore the rest of files.

      • src

        ┣ server         # The core
        ┃ ┣ routes.ts   # Server routes file
        ┃ ┗ config.ts   # Server configuration file
        ┃
        ┣ public         # The public zone
        ┃ ┗ index.html
        ┃
        ┣ i18n/          # Internationalization
        ┃ ┣ en.json
        ┃ ┗ ar.json
        ┃
        ┗ index.ts       # The main entry point

  
  
  

  • API ⛓️

    • ..

      ..

      ..

    • ..

      ..

      ..

    
    
    

  • Related 🔗

    • @minejs/hmm

    • @minejs/server

    • @minejs/i18n

    • @minejs/db

---