Skip to content

Latest commit

 

History

History
122 lines (99 loc) · 4.11 KB

README.md

File metadata and controls

122 lines (99 loc) · 4.11 KB
Raw

serverX

License: MIT Codacy Badge Issues Pull Request Releases Mailing List gitter

serverX Logo

A HTTP/HTTPS Web Server Handler by (C) Bytes Club

Installation

  • Install dependencies and toolchain
$ apt-get update
$ apt-get install build-essential zlib1g-dev php7.0-cgi
  • Get Source Code
$ apt-get install git
$ git clone https://github.com/BytesClub/serverX.git
$ cd serverX
  • Build program (Make sure current directory contains a Makefile)
$ make

Testing

  • Open terminal and go to Source directory
$ make test
  • Open any browser and go to following address
http://localhost:8080

Contributing

  • Reference: Contributing Guidelines

    • Every commit must follow the following standard:
    Shortlog: Commit Message

commit body

Fixes: #<issue_number>
[Closes: <In case of multiple issues>]

Signed-off-by: [Your name] <your email>

  • Contributing in GitHub:

    • Fork the project in your account and clone to your local machine.
    • Create a branch abiding following format:
    <Your-Name/Your-Username>/Issue-<IssueID>
    • Update with latest at master branch.
    $ git remote add upstream https://github.com/BytesClub/serverX.git
$ git fetch upstream
$ git checkout [-b] <your-branch>
$ git rebase upstream/master --strategy recursive -X theirs
$ git push origin <your-branch> [-u]
    • Make changes and commit them according to the guideline provided.
    • Do not commit anything to the master branch.
    • Create a Pull Request to the Base Repository.

  • Contributing via Patches:

    • Install git-email package on top of git-core package already installed and configure accordingly.
    • Create a branch abiding following format:
    <Your-Name/Your-Username>/Issue-<IssueID>
    • Update with latest at master branch.
    $ git rebase origin/master --strategy recursive -X theirs
    • Make changes and commit them according to the guideline provided.
    • Do not commit anything to the master branch.
    • Format patch from the commits you've created.
    $ git format-patch <commit> -<N> --cc="Progyan Bhattacharya <[email protected]>" -o ../serverX-patches

    $ git send-email ../serverX-patches/<patch> --to="[email protected]" --subject="[Patch] BytesClub: serverX: <Short Patch Info>"

Legal Notice

Copyright 2017 The serverX Authors
Maintainer: Bytes Club (https://bytesclub.github.io)<[email protected]>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.