Giter VIP home page Giter VIP logo

arrow's Introduction

Arrow

The arrow of time, Artsy edition.

This 2020 Hackathon project implements a web-published timeline and a CMS for documenting milestones in Artsy's history.

main

The major pieces:

  • A NextJS project, with support for Typescript and Palette
  • A Netlify deployment for the static site generated from the NextJS project
  • A NetlifyCMS configuration that allows editors to update this repo (and trigger a new static site deploy on each push to master)
  • Data, seeded originally from the document created in 2019, and now managed via the CMS

Meta

Getting started

Clone and install

git clone [email protected]:artsy/arrow.git
cd arrow
yarn install

Compile individual CMS-managed files in _entries/* into a single JSON file at data/entriesList.json

yarn data

Start the NextJS dev server

yarn dev

You should now have a hot-reloading NextJS dev server running at http://localhost:3000/

The project is laid out as follows. The pages and components directories are where most of the action is:

.
├── _entries   # content directory, managed via NetlifyCMS
├── data       # derived from content files, with `yarn data`
├── pages      # NextJS page components
├── components # regular React components
├── public     # static files
│   └── admin  # static files for NetlifyCMS UI
└── scripts    # custom scripts for e.g. data munging

Contributing

  • Developers: Fork and PR as usual, even the CMS-managed data files under _entries. Merges to master will result in a deployment.
  • Editors: Use the CMS. A signup with Netlify Identity may be required.

arrow's People

Contributors

anandaroop avatar

Watchers

 avatar  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.