Ocean Data Foundation Website

🚀 Quick start

1. Download site dependencies.

   Use Yarn to install packages from the NPM package manager.

   # add packages with yarn
   yarn

   If you don't have Yarn installed on your machine, follow installation instructions from yarnpkg.org

1. Start developing.

   Navigate into the site’s directory and start it up.

   cd ODF-Landingpage/
   yarn develop

   NB: Make sure you are on the development- or a feature branch before committing changes in your code.

2. Open the source code and start editing!

   The site is now running at http://localhost:8000!

   Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying data from contentful. Learn more about using this tool in the Gatsby tutorial.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in the project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. /src: This directory will contain all of the code related to what you will see on the front-end of the site such as the site header or a page template. src is a convention for “source code”.

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of the code consistent.

5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about the site (metadata) like the title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

8. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

9. LICENSE: Gatsby is licensed under the MIT license.

10. yarn.lock (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

11. package.json: A manifest file for Node.js projects, which includes things like metadata. This manifest is how npm knows which packages to install for your project.

💫 Deploy

This site is linked to a github repository to make continuous deployment fast and easy.

Each time you push to the master- or stage branch on GitHub, Netlify runs a build and deploys the result to their CDN.

master branch deploys the production build at oceandata.earth

stage branch deploys a test/preview build at oceandata-preview.netlify.com. This build is password protected with the following password: odfp@ssw0rd1#