# custom-distribution-service

**Repository Path**: jenkins-zh/custom-distribution-service

## Basic Information

- **Project Name**: custom-distribution-service
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-07-09
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Jenkins Custom Distribution Service


[![Gitter](https://badges.gitter.im/jenkinsci/jenkins-custom-distribution-service.svg)](https://gitter.im/jenkinsci/jenkins-custom-distribution-service?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/b4fea9e79e2a485a929ed7aa71b222a1)](https://www.codacy.com/gh/jenkinsci/custom-distribution-service?utm_source=github.com&utm_medium=referral&utm_content=jenkinsci/custom-distribution-service&utm_campaign=Badge_Grade)
[![GitHub license](https://img.shields.io/github/license/jenkinsci/custom-distribution-service)](https://github.com/jenkinsci/custom-distribution-service/blob/master/LICENSE)


## Overview
The main idea behind the project is to build a customizable jenkins distribution service that could be used to build tailor-made jenkins distributions. The service would provide users with a simple interface to select the configurations they want to build the instance with eg: plugins, authorization matrices etc. Furthermore it would include a section for sharing community created distros so that users can find and download already built jenkins war/configuration files to use out of the box.


## QuickStart

You can spin up the entire web application using a docker compose file command: 
Build the containers: 
```
docker-compose up -d --build
```

Run the containers: 
```
docker-compose up
```

### Backend
The backend of the project is built on spring-boot and there is a dockerfile present in the root.

#### Steps to spin up the backend

a) Create a package: 
```
mvn clean package
```

b) Build Dockerfile: 
```
docker build -t cds_backend .
```

c) Run Dockerfile: 
```
docker run -p 5000:8080 cds_backend
```

### FrontEnd
The frontend of the project is built on react and there is a dockerfile present in the frontend directory.

#### Steps to spin up the frontend

a) CD into the front end directory: 
```
cd frontend/
```

b) Build Dockerfile: 
```
docker build -t cds_frontend .
```

c) Run Dockerfile: 
```
docker run -it --rm -v ${PWD}:/app -v /app/node_modules -p 3001:3000 -e CHOKIDAR_USEPOLLING=true cds_frontend
```

## Useful Links

a) [Project page](https://www.jenkins.io/projects/gsoc/2020/projects/custom-jenkins-distribution-build-service/)

b) [GSoC Proposal](https://docs.google.com/document/d/1C7VQJ92Yhr0KRDcNVHYxn4ri7OL9IGZmgxY6UFON6-g/edit?usp=sharing)

c) [Design Document](https://docs.google.com/document/d/1-ujWVJ2a5VYkUF6UA7m4bEpSDxmb3mJZhCbmoKO716U/edit?usp=sharing)