Giter Club home page Giter Club logo

docs's Introduction

amp.dev

This repository is meant to work towards the relaunch of the official website of ampproject.org until we reach a progress that makes a merge over to the original repository beneficial.

Requirements

  1. Install the LTS version of NodeJS. An easy way to do so is with nvm. (Mac and Linux: here, Windows: here)

    $ nvm install --lts
  2. Install Grow the static site generator used to build amp.dev:

    $ curl https://install.grow.io | bash
  3. Install the stable version of Yarn. (Mac and Linux: here, Windows: here)

    $ curl -o- -L https://yarnpkg.com/install.sh | bash
  4. Install the dependencies for the project:

    $ cd platform
    $ yarn

Develop

To start developing start a pipeline that takes care of building the frontend, collecting all needed files and start Grow when finished. The pipeline then watches the sources files for changes and rebuilds them if needed.

$ cd platform
$ npm run develop

If you additionally want to import the needed documents pass in the --import option to the command and export a valid GitHub access token beforehand like with

$ export AMP_DOC_TOKEN="c59f6..."
$ npm run develop -- --import

To run a local test build that does all the minifying and vends the static pages instead of proxying them through to Grow you can run

$ cd platform
$ npm run build:local
$ npm run start:local

Build & Deploy

To build and deploy to the staging environment on Google App Engine run the following

$ cd platform
$ yarn run build:staging
$ yarn run start:staging

Copyright 2018 The AMP HTML Authors. All Rights Reserved.

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.

docs's People

Contributors

pbakaus avatar sidval avatar leeee avatar crystalonscript avatar matthiasrohmer avatar captainlee2009 avatar coryphwang avatar rachnakumar avatar meggin avatar mshetty2 avatar techhtml avatar wuzhi1023 avatar mattludwig avatar lilies avatar bretmorris avatar keevcodes avatar erwinmombay avatar bengotow avatar renovate-bot avatar mrjoro avatar morsssss avatar rsimha avatar yunelee avatar jeremydw avatar shumnee avatar oikwsat avatar kul3r4 avatar dereknongeneric avatar cramforce avatar zhouyx avatar

Watchers

James Cloos avatar Andrew Watterson avatar

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.