Giter VIP home page Giter VIP logo

figurefigure's Introduction

Figure Figure

Built with Node, Github Pages & Gatsby (including 'Gatsby React Boilerplate' template).

Requirements

Features

  • Basic configuration and folder structure.
  • Uses postcss and sass (with autoprefixer and pixrem).
  • Uses data from local json files.
  • Contains Node.js server code for easy, secure, and fast hosting.
  • SVG sprites: Add your SVG icons in components/icon as .icon files and use them.

Setup

First, clone this repository with git clone https://github.com/jjaburke91/figurefigure.

Before all stages, make sure you've installed the required dependencies with npm install in the root directory.

Develop

  1. Run npm run dev, this will try execute the development process and local server.
  2. You should see a message saying your local server has started at http://localhost:8000/. Open this URL in the browser to view.
  3. Start coding, the development process will automatically rebuild the local project on any code changes.

Note, this build is slightly different to the build that'll be used on the live site. To test a build matching how it'd be live, follow the next guide Build.

Build

This will locally build the application, in the same way it'll be built for the live site.

  1. Run npm run build. You should see a Done building message. This will build the application into a public folder.
  2. Now you can test this build locally using npm run serve. This will create a local server running from the public folder.
  3. You should see a message saying the server is running locally at http://localhost:9000. Open this URL in the browser to test.

Deploy

The live website is served via Github pages, routing figurefigure.fr to the Github pages host. Follow the next steps to deploy:

  1. Locally test your build process with the above Build guide, and ensure everything is working there before deploying.
  2. To deploy live, run npm run deploylive. This will build the app, and commit the build files to a gh-pages branch in the repository - Github pages will serve the website from this branch.
  3. Done! You can view the site at figurefigure.fr. Remember, it can take a few minutes for changes to become visible.

Making site updates

Please work on a feature branch, and to put a change live, create a pull request going into master. A code owner can sign it off, allow it to be merged into master and deployed.

Considerations

  • RTL: The usual method of generating different css file for RTL pages (as seen in static-html-boilerplate) will not work out of the box here since Gatsby pulls all the css together, this means the RTL css will override the LTR one.

figurefigure's People

Contributors

jjaburke91 avatar aberaud avatar indiraberaud avatar

Watchers

 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.