Giter Club home page Giter Club logo

binary-static's Introduction

Binary-Static

This repository contains the static HTML, Javascript, CSS, and images content of the Binary.com website.

Installation

In order to work on your own version of the Binary.com Javascript and CSS, please fork this project.

You will also need to install the following on your development machine:

Note:

You need to have:

  • The latest version of node
  • Version 4.x.x of npm (npm install npm@4 -g)

Use a custom domain

In order to use your custom domain, please put it in a file named CNAME inside scripts folder of your local clone of binary-static.

How to work with this project

Deploy to your gh-pages for the first time

  1. Register your application here. This will give you the ability to redirect back to your github pages after login. Use https://YOUR_GITHUB_USERNAME.github.io/binary-static/en/logged_inws.html for the Redirect URL and https://YOUR_GITHUB_USERNAME.github.io/binary-static/en/redirect.html for the Verification URL.

    If you're using a custom domain, replace the github URLs above with your domain.

  2. In src/javascript/config.js: Insert the Application ID of your registered application in user_app_id.

  • NOTE: In order to avoid accidentally committing personal changes to this file, use git update-index --assume-unchanged src/javascript/config.js
  1. Run grunt dev

Deploy js/css and template changes together

grunt dev

Deploy only js/css changes

grunt deploy

Deploy some template changes

grunt dev --path=about-us

Using sub-folders

There are times that you are working on various branches at the same time, and you want to deploy/test each branch separately on your gh-pages, you can simply use --branch=branchname for grunt commands:

In order to remove the created folders from your gh-pages, you can use either:

  • grunt dev --cleanup: removes all br_* folders and deploys to the root folder.

    or

  • grunt shell:remove_folder --folder=br_branchname1,br_branchname2,...: only removes the specified folder(s) from your gh-pages.

Preview on your local machine

  • To preview your changes locally, run sudo grunt serve
  • It will watch for js/css changes and rebuild on every change you make.
  • To test changes made to templates, you need to re-compile them:
    • grunt shell:compile_dev to re-compile all templates.
    • grunt shell:compile_dev --path=about-us to re-compile only template(s) which serve about-us path in URL.
  • To fix eslint errors run npm run eslint

Release

grunt release --staging=1|--production=1|--translations=1 [--cleanup] [--reset]

(The value is needed when more than one option is used)

Parameters:

  • --staging or --production or --translations (mandatory)
    • In order to prevent accidentally releasing to the wrong target, it is mandatory to provide one of these parameters.
    • Your remote origin will be checked to be the correct target of the given parameter.
    • Your current branch will be checked to be the correct branch of the given parameter.
  • --cleanup [optional]
    • Create CNAME file with proper value according to remote origin
    • Deploy to gh-pages with the option add: false
  • --reset [optional]
    • Removes all commits from gh-pages branch before release (staging only)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.