The video-summarisation webpages for project RPG-2015-188 have been developed using Gatsby.
-
Install node.js
Visit the Node.js site and install the recommended version for your operating system. To check the installation run:
node --version
Installing node should also install the package manager npm. Check by running:
npm --version
-
Install the Gatsby CLI
The Gatsby CLI allows you to run commands to develop Gatsby sites.
npm install --global gatsby-cli
Check the installation with:
gatsby --version
-
Clone repository
Clone this repository to a local directory.
git clone [email protected]:clarematthews/PROJECT-RPG-2015-188.git
Navigate to the cloned project folder.
- Using npm
Using npm and the Gatsby CLI, run:
gatsby develop
- Using yarn
Yarn can be used as an alternative to npm. Run:
yarn develop
- View the site
Once the project has compiled, navigate to http://localhost:8000 to view the site locally.
A deployment of the site is automatically triggered when pushing to the master branch of this repository, or can be manually triggered from the Netlify project page.
The top-level structure of the src
directory is as follows:
.
├── components
├── images
├── pages
-
components
: This directory containslayout.css
, which is the main css file for the project. To add images to the site, add the details to thequery
object in theimage.js
. For more information on adding images, see the Gatsby documentation. -
images
: All the images that appear on the site are in theimages
directory, organised by page. -
pages
: A separate javascript file exists for each page of the website. To link between pages, see the Gatsby documentation.
Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:
-
For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
-
To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.