Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 2.97 KB

DEVELOPMENT.md

File metadata and controls

86 lines (55 loc) · 2.97 KB

Satsummit satellite icon

Development

The Satsummit website is built using Gatsby.

🚀 Start developing

  1. Install Project Dependencies

    To set up the development environment for this website, you'll need to install the following on your system:

    • Node v16 (To manage multiple node versions we recommend nvm)
    • Yarn Package manager
  2. Make sure to use the correct node version.

    Assuming you already have nvm installed on your machine, this is installing the node version specified in .nvmrc.

    nvm install

    💡You can configure your shell to automatically call nvm use when entering a directory with a .nvmrc file. That way you don't have to remember this step.

  3. Install the dependencies.

    This assumes that you already cloned the repository and have yarn installed globally on your machine.

    yarn install

    Note: On Apple Silicon M1, you need to install libvips first.

  4. Start developing.

    yarn start
  5. Open the source code and start editing!

    Your 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 your data. Learn more about using this tool in the Gatsby tutorial.

🧐 What's inside?

A quick look at the top-level files and directories and some notes around the project structure.

TODO: Complete

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── .eslintrc
├── yarn.lock
├── package.json
└── README.md

🎓 Learning Gatsby

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.

💫 Deploy

Deployment is being done to gh-pages via Github Actions.