• Quick Start 🔥

  The simplest, fastest, and most organized way to build production-ready servers with Bun.

  This repository uses @je-es/server and managed by space.

  • Setup

    install space first.

    • Create

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

    • Manage

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

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

  
  

  • Structure

    • Root

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

      • src

        ┣ backend   # The backend folder
        ┃ ┗ ...
        ┃
        ┣ frontend  # The frontend folder
        ┃ ┗ static # Static files (css, html, imgs, ..)
        ┃
        ┗ main.ts   # The main entry point

        • backend

        ┣ config                # Server configuration folder
        ┃ ┗ index.ts           # - main config file
        ┃
        ┣ routes                # Server routes folder
        ┃ ┗ index.ts           # - main routes file
        ┃
        ┗ index.ts              # Backend entry point

---