https://github.com/draviavemal/git-webserver

Git-Webserver is a web-based self hostable version control repository server, for maintaining source code of project development that use Git . It is similar to GitHub, but it run's in your server.
https://github.com/draviavemal/git-webserver

expressjs git gitserver mongodb nodejs server web webserver website

Last synced: 20 days ago
JSON representation

Git-Webserver is a web-based self hostable version control repository server, for maintaining source code of project development that use Git . It is similar to GitHub, but it run's in your server.

• Host: GitHub
• URL: https://github.com/draviavemal/git-webserver
• Owner: DraviaVemal
• License: lgpl-3.0
• Created: 2018-06-26T14:55:59.000Z (over 6 years ago)
• Default Branch: DevMain
• Last Pushed: 2018-09-22T01:55:29.000Z (over 6 years ago)
• Last Synced: 2024-03-24T19:44:44.820Z (10 months ago)
• Topics: expressjs, git, gitserver, mongodb, nodejs, server, web, webserver, website
• Language: JavaScript
• Homepage: https://draviavemal.github.io/GIT-WebServer/
• Size: 3.13 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Git-WebServer

## Message

    Under Development project, wait for release v1.0.0 for backward compatable updates to start

## Beta version installation

    npm i git-webserver

## Beta version deployment

    In app file Ex:"index.js"

```javascript

require("git-webserver")(__dirname);

```

## Scope Coverd

    User Authentication System both web and git push

    Git Repo. Creation, File Explorer, Branch View, General History,Deletion

    Basic UI for all functionality

## Config option

    create config.json in root directory

    Available options

   | Option |   Type   | required | Description | Default |

   | ------ |:--------:|:--------:|:-----------:| -------:|

   | salt   | String | true  | Encription secrect key.| *auto* |

   | cluster| Bool | false | To run the app in cluster mode across multiple processor. | true |

   | logging| Bool | false | Console logging. | false |

   | port   | Integer | false | port number for your application. | 80 |

   | gitURL | String | false | URL path for your git repository. | "/git"|

   | appName| String | false | Application name. | "Git-WebServer" |

   | dbname | String | false | DataBase name. | "GitWebServer" |

   | dbURL  | String | false | DataBase connection url. | "localhost" |

   | dbUser | String | false | DataBase Authendication user. | *empty* |

   | dbPassword | String | false | DataBase Authendication password. | *empty* |

    Note : There are still many config features provided to make application flexible to run in multiple environment.

    The detailed documents will be updated in future.

## Description

    Web base version control system backed by GIT.

## Contribution

    Please have the code well commented.

    Cypress is the testing system used by dev team.

    add your code's test case in cypress if required before raising PR

    Contributors are welcome.

    please contact at [email protected] for details.

## Supported Platform

    Windows

    Linux

## Pre-Requirement

    Node JS

    Git SCM

    MongoDB

    Note : Development underway to remove Git SCM instalation dependency and to support multiple database.

## TODO

    Pull Request Handling

    Code documentaion

    Test Case Update for dynamic feature

    UI modernisation

    Brute force protection

    Request rate limiter

    Strengthen validation and sanitisation

## Ideas

    -All ideas are welcome and will be considered seriously for incorporation