gatsby-starter-styled-ts

This starter was based on the source code of my personal blog/website and aims to accelerate the development of new projects by keeping the dependencies I like to use configured.

🖥️ Tech Stack

• Built with Styled Components and TypeScript.
• Includes a test suite using Jest and Testing Library.
• Also configured with ESLint, Prettier, stylelint, Husky, lint-staged, and more.
• This starter features two GitHub Actions - one for maintaining updated dependencies and another for deploying the project as GitHub Pages.

📋 Requirements

This project requires Node.js 18 or higher and yarn as package manager.

🎯 Using this starter

Use the Gatsby CLI (install instructions) to create a new site, specifying the gatsby-starter-styled-ts.

$ npx gatsby new your-project-name [email protected]:diegocoxta/gatsby-starter-styled-ts.git

⚙️ Scripts

• It provides several Gatsby CLI aliases, including build, develop, serve, and clean, which can be executed using yarn <command>.
• Use yarn prettier, yarn eslint, and yarn stylelint to format your source code according to the respective configuration files.
• Use yarn test to run the test suite with Jest.
• Use yarn prepare to set up Husky git hooks.

⌨️ Developing

1. Clone this repo with git.
2. Install dependencies by running yarn install within the directory that you cloned (probably gatsby-starter-styled-ts).
3. Start the development server with yarn start.
4. Open development site by going to http://localhost:8000 in your browser.

📐 Contributing

See CONTRIBUTING.md for details.

☕ Get in touch

Say hello on twitter or email