toufiq-austcse / deployit

A simple Render (https://render.com/) type service where users can deploy their web-services

DeployIt

A simple Render (https://render.com/) type service where users can deploy their web-services

Dependencies

• PostgreSQL : As data storage
• RabbitMQ : To process task async
• Docker : To build and run the deployment images
• FE: VueJs, Bootstrap

FE Repo URL : https://github.com/toufiq-austcse/deployit-frontend

Screenshots

Some screenshots of the application. Login page Signup page Profile page Create Deployment Part-1 Create Deployment Part-2 Home Page Details Page URL

Run Locally

In progress...

Database Schema

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    email VARCHAR(255) UNIQUE NOT NULL,
    name VARCHAR(255) NOT NULL,
    password VARCHAR(255) NOT NULL,
    createdAt TIMESTAMP NOT NULL DEFAULT NOW(),
    updatedAt TIMESTAMP NOT NULL DEFAULT NOW()
);

CREATE TABLE deployment_types (
    id SERIAL PRIMARY KEY,
    name VARCHAR(255) UNIQUE NOT NULL,
    status VARCHAR(255) NOT NULL,
    createdAt TIMESTAMP NOT NULL DEFAULT NOW(),
    updatedAt TIMESTAMP NOT NULL DEFAULT NOW()
);


CREATE TABLE deployments
(
    "createdAt"           TIMESTAMP DEFAULT NOW() NOT NULL,
    "updatedAt"           TIMESTAMP DEFAULT NOW() NOT NULL,
    id                    PRIMARY KEY,
    short_id              VARCHAR(255) NOT NULL UNIQUE,
    deployment_type_id    INTEGER                 NOT NULL,
    name                  VARCHAR(255)            NOT NULL,
    sub_domain_name       VARCHAR(255)            NOT NULL,
    mapped_port           VARCHAR(255),
    status                VARCHAR(255)            NOT NULL,
    last_deployed_at      TIMESTAMP,
    repository_url        TEXT                    NOT NULL,
    branch_name           VARCHAR(255)            NOT NULL,
    root_dir              VARCHAR(255),
    docker_img_tag        VARCHAR(255),
    container_id          VARCHAR(255),
    user_id               INTEGER                 NOT NULL,
    repository_full_name  TEXT,
    environment_variables JSON
);

API Reference

SignUp

POST /api/v1/auth/signup

{
  "email": "string",
  "name": "string",
  "password": "string"
}

Response 201

{
  "status": 201,
  "message": null,
  "errors": [
  ],
  "data": {
    "token": {
      "access_token": "string"
    },
    "user_info": {
      "id": "string",
      "email": "string",
      "name": "string"
    }
  }
}

Login

POST /api/v1/auth/login

{
  "email": "string",
  "password": "string"
}

Response 200

{
  "status": 200,
  "message": null,
  "errors": [],
  "data": {
    "token": {
      "access_token": "string"
    },
    "user_info": {
      "id": "string",
      "email": "string",
      "name": "string"
    }
  }
}

Me

GET /api/v1/auth/me

Header

{
    Authorization: {access_token}
}

Response 200

{
  "status": 200,
  "message": null,
  "errors": [],
  "data": {
    "id": "string",
    "email": "string",
    "name": "string"
  }
}

List Deployment Types

GET /api/v1/deployments/type

Header

{
    Authorization: {access_token}
}

Response 200

{
  "status": 200,
  "message": "",
  "errors": [],
  "data": [
    {
      "id": 0,
      "name": "string",
      "status": "string"
    }
  ]
}

Create Deployment

POST /api/v1/deployments

Header

{
    Authorization: {access_token}
}

Req Body

{
  "deployment_type_id": 0,
  "name": "string",
  "repository_link": "string",
  "branch_name": "string",
  "root_dir": "string",
  "environment_variables": {}
}

Response 201

{
  "status": 201,
  "message": "",
  "errors": [],
  "data": {
    "id": "string",
    "deployment_type": {
      "id": "string",
      "name": "string"
    },
    "name": "string",
    "sub_domain_name": "string",
    "status": "string",
    "last_deployed_at": "string",
    "repository_link": "string",
    "branch_name": "string",
    "root_dir": "string",
    "environment_variables": {}
  }
}

GET Single Deployment

GET /api/v1/deployments/{id}

Header

{
    Authorization: {access_token}
}

Response 200

{
  "status": 200,
  "message": "string",
  "errors": [],
  "data": {
    "id": "string",
    "deployment_type": {
      "id": "string",
      "name": "string"
    },
    "name": "string",
    "sub_domain_name": "string",
    "status": "string",
    "last_deployed_at": "string",
    "repository_link": "string",
    "branch_name": "string",
    "root_dir": "string",
    "environment_variables": {}
  }
}

List Deployments

GET /api/v1/deployments/{id}?page={page}&limit={limit}

Header

{
    Authorization: {access_token}
}

Response 200

{
  "status": 200,
  "message": "string",
  "data": {
    "deployments": [
      {
        "id": "string",
        "deployment_type": {
          "id": "string",
          "name": "string"
        },
        "name": "string",
        "sub_domain_name": "string",
        "service_url": "string",
        "status": "string",
        "last_deployed_at": "string",
        "repository_url": "string",
        "repository_full_name": "string",
        "branch_name": "string",
        "root_dir": "string",
        "environment_variables": {}
      }
    ],
    "pagination_meta": {
      "itemCount": 0,
      "totalItems": 0,
      "itemsPerPage": 0,
      "totalPages": 0,
      "currentPage": 0
    }
  },
  "errors": []
}

Update Environment Variables

GET /api/v1/deployments/{id}/environment-variables

Header

{
    Authorization: {access_token}
}

BODY

{
  "environment_variables": {}
}

Response 201

{
  "status": 201,
  "message": "string",
  "errors": [],
  "data": {}
}

Validate Github Repository

GET /api/v1/repositories/validate?repository_url={repository_url}

Header

{
    Authorization: {access_token}
}

Response 200

{
  "status": 200,
  "message": "string",
  "data": {
    "repo_full_name": "string"
  },
  "errors": []
}