Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 2.17 KB

README.md

File metadata and controls

48 lines (38 loc) · 2.17 KB
Raw

Deployer

Deployer is a self-hosted, open-source, self-configuring tool for deploying your projects to the cloud. It is designed to be as easy to use as possible, and to make it easy to get started.

Build Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

Endpoints

API endpoints

Authentication

Path Method Description Parameters
/api GET The API root None
/api/regsiter POST Create a new account name,email, password
/api/login POST Authenticate a user email,password
/api/logout POST End the session of the current user none
/api/user GET Get the current authenticated user none

Config routes

Path Method Description Parameters
/api/config GET Get all the configs none
/api/config/{id} GET Get a config by database ID none
/api/config POST Create a config name,description,command
/api/config/{id} DELETE Delete a config from the database none
/api/config/{id} PUT/PATH Update a config in the database name,description,command

Webhooks

Path Method Description
/github POST Github's webhook listener
/bitbucket POST Bitbucket's webhook listener
/gitlab POST Gitlab's webhook listener