Getting started with GCWeb
GCWeb is a pretty cool open source project. It is share on GitHub, which is a Git repository web-based hosting service which offers all of the functionality of Git as well as adding many of it’s own features.
Before you begin:
- This site is powered by Node.js. Check to see if you're on the version of node we support.
- Have you read the code of conduct?
- Check out the existing issues and see if we accept contributions for your type of issue.
- How to install
git,node.jsandjava developer kit - How to fork the GCWeb repository
- How to install all the GCWeb dependacies (
/script/setup)
First let's start by creating a GitHub account
Installing on Linux
If you want to install the basic Git tools on Linux via a binary installer, you can generally do so through the package management tool that comes with your distribution. If you’re on Fedora (or any closely-related RPM-based distribution, such as RHEL or CentOS), you can use dnf:
$ sudo dnf install git-all
If you’re on a Debian-based distribution, such as Ubuntu, try apt:
$ sudo apt install git-all
For more options, there are instructions for installing on several different Unix distributions on the Git website, at https://git-scm.com/download/linux.
Installing on macOS
Option 1
There are several ways to install Git on a Mac. The easiest is probably to install the Xcode Command Line Tools. On Mavericks (10.9) or above you can do this simply by trying to run git from the Terminal the very first time.
$ git --version
If you don’t have it installed already, it will prompt you to install it.
Note: Installing Xcode and Xcode Command Line Tools make take several hours to download and install altogether. Arm yourself with a lot of patience.
Option 2
You can also install it as part of the GitHub for macOS install. Their GUI Git tool has an option to install command line tools as well. You can download that tool from the GitHub for macOS website, at https://desktop.github.com.
Option 3
If you want a more up to date version, you can also install it via a binary installer. A macOS Git installer is maintained and available for download at the Git website, at https://git-scm.com/download/mac.
Installing on Windows
Option 1
There are also a few ways to install Git on Windows. The most official build is available for download on the Git website. Just go to https://git-scm.com/download/win and the download will start automatically. Note that this is a project called Git for Windows, which is separate from Git itself; for more information on it, go to https://gitforwindows.org.
Option 2
To get an automated installation you can use the Git Chocolatey package. Note that the Chocolatey package is community maintained.
Option 3
Another easy way to get Git installed is by installing GitHub Desktop. The installer includes a command line version of Git as well as the GUI. It also works well with PowerShell, and sets up solid credential caching and sane CRLF settings. We’ll learn more about those things a little later, but suffice it to say they’re things you want. You can download this from the GitHub Desktop website.
Download the Node.js source code or a pre-built installer for your platform at https://nodejs.org/en/download/.
Download the Java Developer Kit (legacy) at https://www.oracle.com/java/technologies/javase/jdk13-archive-downloads.html
Go to https://github.com/wet-boew/GCWeb and click on Fork on the top right corner.
New Repository will be created under your account. Just notice your user name and repository name.
Clone the newly created repository to your workspace may be in VS Code or the code editor of your choice.
Once done cloning on your part, we need to install all the dependencies to run GCWeb locally.
Run /script/setup from the GCWeb directory in your command line console.
Run grunt to build the project. You may run grunt --help to see the build target descriptions.
The latest files will now be compiled to the dist/ folder.
