skgtech/devit-gatsby

DEVit website based on Gatsby

devit-gatsby's Issues

Migrate components from our legacy codebase

Our legacy codebase is a Jekyll based website. We did a good job of designing proper components which will make the migration easier.

Moving to a Gatsby based system now, we want to migrate these components to React components. Some base work has already been done and you will find examples on how to do it.

For example, this is the Footer component in our Jekyll website and this is the equivalent React component.

We have also included a Storybook to allow for easier development. Start it with yarn storybook.

To start on this issue, pick a component from this repo (make sure that it's not already in the new repo) and try to migrate it to the new website. Focus on creating a functional component on storybook only and we will focus on putting all of the components together later.

(Create a PR as soon as possible to know that you are working on a specific component)

Setup base CSS

The site is currently missing the base CSS from our legacy repo. Migrate it.

Put all current components to storybook

Lots of components currently are not on the story book. Include them all to ease development.

Setup tooling

• nvm
• linting setup and rules
• deployment setup, environments and process
• bundling (I assume gatsby does this for us)

Design the data model

This will probably be needed in the near future but it's surely not critical at the moment. For now, we can just copy whatever is on our legacy system.

But for the future, we have already talked about moving to a headless CMS in which case we will have to have a predefined and clear data model.

Define clearly our entities and the relationships between them.

Also, have a look at possible solutions for a headless CMS, such as Contenful and Strapi.

Documentation

Introduction and guides

• Introduction to the stack
• Directory structure
• Quick tips and guides on how to add new features or debug things locally
• How to contribute
• Conventions

Setup

• Setting up the environment
• Installation instructions

Release process

• step by step instructions on going from local to stage and prod