Naturaily/stunning-avocado

Turborepo - Naturaily

📚 Features

• 🏎️ Next.js - Fast by default, with config optimized for performance (app routing).
• 🌈 Turborepo - Turborepo is a high-performance build system for JavaScript and TypeScript codebases.
• 💅 Tailwind CSS - A utility-first CSS framework for rapid UI development.
• ✨ ESlint and Prettier - For clean, consistent, and error-free code.
• 🧪 Jest and React Testing Library - For rock-solid unit and integration tests.
• 📕 Storybook - Create, test, and showcase your components.
• 💎 Atomic Design - Create a consistent, reusable, and atomic design system.
• 🚀 GitHub Actions - Pre-configured actions for smooth workflows.
• 💻 T3 Env - Manage your validation for type-safe environment variables.
• 📚 Storyblok - Ready integration with CMS.
• 🧬 Codegen - Generate code from your GraphQL schema.
• 🖥️ TanStack Query (react-query) - Powerful asynchronous state management for TS/JS.
• 🔥 Framer motion - Powerful animation library.

Table of Contents

• Turborepo Next.js Boilerplate
  • 📚 Features
  • Table of Contents
  • 📦 Workspaces available
    • 🖥️ Apps
    • 📄 Packages
    • 📚 Storyblok
  • 👌 Requirements
  • 🎯 Getting Started
  • 📃 Scripts Overview

📦 Workspaces available

🖥️ Apps

• app
• storybook-ui

📄 Packages

• @natu/env
• eslint-config-custom
• @natu/googletagmanager
• @natu/hooks
• @natu/jest-config
• @natu/next-link
• @natu/responsive-image
• @natu/react-query-gql
• @natu/storybook
• tailwind-config
• tsconfig
• @natu/ui
• @natu/utils

📚 Storyblok

• @natu/storyblok-api
• @natu/storyblok-page-compositions
• @natu/storyblok-ui
• @natu/storyblok-utils

👌 Requirements

node - v16.14.0
yarn - v1.22.17

✅ Node

To install Node.js, you can follow the nvm documentation available at https://github.com/nvm-sh/nvm.

nvm use 16

Once installed, you can check the version using the following command:

node --version

Ensure that the command returns v16.14.0 to confirm that you have the correct version installed.

✅ Yarn

The Turbo Repo utilizes Yarn package manager.

To install Yarn, you can follow the official documentation available at https://yarnpkg.com. Once installed, you can check the version using the following command:

yarn --version

Ensure that the command returns 1.22.17 to confirm that you have the correct version installed.

🎯 Getting Started

To start using the Turbo Repo with Node.js and Yarn, follow these steps:

1. Clone the Turbo Repo repository to your local machine.

2. Navigate to the cloned repository:

   cd <your folder>

3. Install project dependencies:

   yarn install

4. Fill in the required environment variables. (check .env.example file) in the appropriate packages.

5. Run the development server:

   yarn dev

6. Start using the Turbo Repo according to the available documentation and guidelines.

For more information on how to use the Turbo Repo and its features, please refer to the specific documentation provided with the repository.

📃 Scripts Overview

All commands are available in the main package.json