ecmasytax.io

This is an offline-first PWA for ECMAScript syntax reference. It is built with React (+ Redux) and features server-side rendering complete with critical path CSS.

API

ECMASyntax.io features an api accessible at /api which currently has 3 endpoints:

• /pages - retrieve a list of all pages
• /pages/{specificationName}/{categoryName}/{pageName} - retrieve the content for a particular page
• /pages/{pageID} - retrieve the content for a particular page ID

Running the site locally

1. Clone the repo
2. cd ecmasyntax.io
3. npm install

Setting up credentials

The content for ECMASyntax is fetched from contentful and in order to run the site locally you'll need to edit credentials.js, into which you will need to update the space and accessToken properties using your respective contentful space values. You can use these values which correspond to a demo contentful space with the correct content model and some sample data (although as this is publically avaliable it will obviously be subject to change):

// credentials.js - demo values
module.exports = {
  space: '55mxa9rwgn9l',
  accessToken: '3a658f972dd2f2cc8cc5dc4977970dc0009584ab4859306e5c9649a8d109b965',
};

Once you've done that you should be able to run npm run dev to set up a development environment or npm start to run a full, production ready build (you'll probably need to comment out app.use(enforce.HTTPS({ trustProtoHeader: true })); in src/server/server.js to get a production build working on localhost).

Finally, navigate to localhost:5000.

License

The MIT License © 2017 Alex Saunders. All rights reserved.