Code Monkey home page Code Monkey logo

sea-builder's Introduction

SEA-Builder

Build a Single Executable Application (SEA) from a Node.js project with ease. SEA-Builder streamlines the process of packaging your Node.js application into a standalone executable for Windows, Linux, and macOS platforms.

License: MIT Build Status npm version Code Style

Features

  • Cross-Platform Support: Build executables for Windows, Linux, and macOS.
  • Easy to Use: Simple command-line interface with clear usage instructions.
  • Customizable: Set your application's icon on Windows and specify the output executable name.
  • Efficient: Utilizes esbuild for fast bundling of your Node.js project.
  • Logging: Detailed logs help you track the build process and troubleshoot issues.
  • Security (Optional): Implements obfuscation that allows you to be a step ahead of those pesky reverse engineers.

Installation

To use SEA-Builder, you must have Node.js installed on your system. Once you have Node.js, you can install SEA-Builder globally or locally in your project.

Global Installation

npm install -g sea-builder

Local Installation

npm install --save-dev sea-builder

Usage

sea-builder -i server.ts -p win32

Options

  • -i, --input <file>: Input file (e.g., server.ts).
  • -icon, --icon <file>: Icon file (e.g., icon.ico) [Windows only].
  • -p, --platform <platform>: Target platform (win32, linux, or macos).
  • -o, --obfuscate: (Optional) Obfuscates the produced bundled script right before baking it into the executable.

Examples

Build for Windows:

sea-builder -i server.ts -p win32

Build for Linux:

sea-builder -i server.ts -p linux

Build for macOS:

sea-builder -i server.ts -p macos

Contributing

Contributions are welcome! If you have a feature request, bug report, or a pull request, please open an issue or submit a PR.

License

MIT © AxDSan

Acknowledgments

  • Thanks to the contributors who help maintain and improve this project.
  • Special thanks to the creators and maintainers of the dependencies used in this project.

sea-builder's People

Contributors

axdsan avatar

Stargazers

Javier O. Cordero Pérez avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.