Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.17 KB

README.md

File metadata and controls

60 lines (39 loc) · 2.17 KB
Raw

Passenger Server

Node.js Nest.js Passenger GitHub Repo stars GitHub Issues or Pull Requests GitHub Issues or Pull Requests GitHub License

Passenger Server is the translation utility to interact with Passenger Core over HTTP. You can think of Passenger CLI as a kernel and Passenger Server as a shell. You can use the CLI tool standalone, but if you want to access its power over the Web, here is the server.

The main idea of ​​using Passenger as a web server was born to be able to use it on your own 'self-hosted' server. This project is not designed for general use.

 Installation

Prerequisites

You MUST have the corresponding executable of Passenger CLI on app/. You can download it on release page of the project.

Running on Development Mode

  1. Clone the project.
  2. Open the directory.
  3. Install requirements
npm install
  1. Run the project:
npm run start:dev
# Or with Swagger document
SWAGGER=1 npm run start:dev

Note

Of you started server with swagger document, you can see the documentation on https://localhost:3000/swagger

Usage

Once the server is running, you can access the API endpoints at http://localhost:3000.

Contributing

We welcome contributions! Please take a look at CODE OF CONDUCT.

License

This project is licensed under the GNU General Public License v3. See the LICENSE file for details.

For more details, visit our website