Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.98 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.98 KB
Raw

CardForest-Seeds - build setup

This code builds the seeds website from its sources.

Getting Started

Clone the repository

Clone the seeds-website repository using git. Make sure you use the --recursive flag in order to get it with the required submodule:

  1. Install git (if you haven't already)
  2. Clone the repository:
git clone --recursive git://github.com/CardForest/seeds-website.git
cd seeds-website

Note: If already cloned the repository without the --recursive flag then you can still download the submodule by running the following command from the project folder:

git submodule update --init --recursive

Install Dependencies

We build our website using the gulp build system, which runs on the node runtime, We get the tools we depend upon via npm, the node package manager (included with node).

  1. Install node (if you haven't already)

  2. Install gulp (if you haven't already):

     npm install gulp -g

  3. Install our build-specific dependencies:

     npm install

Run Locally

Execute gulp live to start the local server on http://localhost:9000. The server will automatically reload browsers when the sources change. Add -p to run the server in production mode.

Contributing

You can contribute you changes after testing that everything is OK locally. If it's just a small change in a single file then you can edit the file using github GUI. If it's a big change then you should fork this repository, modify your copy of the repository and send a pull request. (...and if that fails, you can just ask for help or send the files by e-mail)