Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 3.33 KB

README.md

File metadata and controls

95 lines (64 loc) · 3.33 KB
Raw

Saglac IO website

Made in our free time with Gatsby. Based on Vagr9K/gatsby-advanced-starter with a huge amount of improvements.

It is built with the JAMStack, which means it's static files enhanced with some JavaScript here and there. Our files are then hosted on Netlify, which really pairs well with Gatsby and the open-source ecosystem.

How to add an event?

See yaml files in ./data/.

  • an event is added as a .yml file in data/io-events
  • authors are in data/authors
  • locations are in data/locations

Make sure the Authors and Locations have the necessary models before creating a new event.

Example PR adding an event: #15

Development

We use NodeJS version 18. You can use NVM or Volta or any other NodeJS version manager to install it.

Install the project:

git clone https://github.com/saglacio/saglac.io.git saglacio
cd saglacio
# Install the dependencies
npm i
# Start the development server
npm start

To ease the development, there are some tools already installed.

GraphQL

An in-browser IDE for exploring GraphQL data available in our Gatsby setup.

While the development server is started (with the previous command), the IDE should be available at:

http://localhost:8000/___graphql

Storybook

Storybook is an open source tool for developing UI components in isolation for React, Vue, and Angular.

Saglac IO storybook

Since we're developing the website with React components, a Storybook app is available in development:

# Run this in another shell in parallel with the dev server
npm run storybook

Then, it should automatically navigate to http://localhost:6006/.

Otherwise, it's always available on the public website under https://saglac.io/storybook.

Webpack Bundle Analyzer

The plugin is configured. Just run

npm run analyze

Then it should automatically open the browser page.

Authors