Skip to content

Commit

Permalink
Merge pull request #24 from SanjeebLama/develop
Browse files Browse the repository at this point in the history 
Develop
  • Loading branch information
@SanjeebLama
SanjeebLama committed May 19, 2023
2 parents 0acfe9b + 081102a commit 369a193
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 77 deletions.
126 changes: 52 additions & 74 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
[![Jira](https://badgen.net/badge/icon/jira?icon=jira&label)](https://github.com/SanjeebLama/Frontend-Skeleton)
[![](https://img.shields.io/badge/Documentation-darkblue?style=flat&logo=notion&logoWidth=20&logoHeight=20)](https://github.com/SanjeebLama/Frontend-Skeleton)


# 🚀 Turbo Frontend Skeleton

Turbo Frontend Skeleton is a template designed to help streamline the process of creating new frontend projects. It comes equipped with all the latest stable dependencies that we use, allowing developers to get up and running quickly.


## Overview

<details><summary><b>A brief introduction to the project</b></summary>

<br>This turborepo uses **Yarn** as a package manager. It includes the following packages/apps:
Expand All @@ -21,42 +20,39 @@ Turbo Frontend Skeleton is a template designed to help streamline the process of
- `tsconfig`: `tsconfig.json`s used throughout the monorepo

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).

**Tech Stack:**

| Technology | Description |
| :----------------------------------------- | :----------------------------------------------------------------------------------------------------------- |
| [Next.js](https://nextjs.org/) | A React-based framework for building modern web applications |
| [Tailwind CSS](https://tailwindcss.com) | A utility-first CSS framework for rapidly building custom designs |
| [Chakra UI](https://chakra-ui.com) | A simple and modular component library for React applications |
| [Storybook](https://storybook.js.org) | An open-source tool for building UI components and pages in isolation |
| [React Query](https://tanstack.com) | A library for managing and caching server state in React applications |
| [React Hook Form](https://react-hook-form.com) | A performant, flexible and extensible forms library for React with easy-to-use validation features |
| [zod](https://github.com/vriad/zod) | A TypeScript-first schema validation tool that is intuitive, type-safe and practical |
| [next-i18next](https://github.com/isaachinman/next-i18next) | A plugin for Next.js that provides a simple, powerful way to add internationalization to your app |
| [Sentry](https://sentry.io/) | A cloud-based platform for error monitoring, logging and aggregation in software applications and services |
**Tech Stack:**

| Technology | Description |
| :---------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------- |
| [Next.js](https://nextjs.org/) | A React-based framework for building modern web applications |
| [Tailwind CSS](https://tailwindcss.com) | A utility-first CSS framework for rapidly building custom designs |
| [Chakra UI](https://chakra-ui.com) | A simple and modular component library for React applications |
| [Storybook](https://storybook.js.org) | An open-source tool for building UI components and pages in isolation |
| [React Query](https://tanstack.com) | A library for managing and caching server state in React applications |
| [React Hook Form](https://react-hook-form.com) | A performant, flexible and extensible forms library for React with easy-to-use validation features |
| [zod](https://github.com/vriad/zod) | A TypeScript-first schema validation tool that is intuitive, type-safe and practical |
| [next-i18next](https://github.com/isaachinman/next-i18next) | A plugin for Next.js that provides a simple, powerful way to add internationalization to your app |
| [Sentry](https://sentry.io/) | A cloud-based platform for error monitoring, logging and aggregation in software applications and services |

**Utilities**

This turborepo has some additional tools already setup for you:

| Technology | Description |
| :--------------| :-------------------------------------------------- |
| TypeScript | A strict syntactical superset of JavaScript |
| ESLint | A pluggable linting utility for JavaScript and JSX |
| Prettier | An opinionated code formatter |



| Technology | Description |
| :--------- | :------------------------------------------------- |
| TypeScript | A strict syntactical superset of JavaScript |
| ESLint | A pluggable linting utility for JavaScript and JSX |
| Prettier | An opinionated code formatter |

#### Project Tree
```

```
frontend-skeleton
├─ .vscode
├─ .vscode
│ └─ settings.json
├─ apps
│ ├─ docs
│ ├─ docs
│ │ ├─ .eslintrc.js
│ │ ├─ README.md
│ │ ├─ next-env.d.ts
Expand All @@ -70,7 +66,7 @@ frontend-skeleton
│ │ │ └─ globals.css
│ │ ├─ tailwind.config.js
│ │ └─ tsconfig.json
│ └─ web
│ └─ web
│ ├─ .eslintrc.js
│ ├─ .lighthouseci
│ ├─ README.md
Expand Down Expand Up @@ -218,44 +214,43 @@ frontend-skeleton
└─ yarn.lock
```

**Atomic Design System for Component Development**
- Atomic Design System is a methodology for creating design systems by breaking down the UI into fundamental building blocks called atoms, molecules, and organisms.
- Atoms are the smallest and most basic building blocks, molecules are groups of atoms that work together to form more complex and functional components, and organisms are groups of molecules and atoms that work together to form a more complete section or module of the interface.
- By using Atomic Design System, designers and developers can create scalable, reusable, and consistent components that can be easily maintained and updated.
- This approach promotes a more efficient and collaborative design process by providing a common language and framework for designers and developers to work with, while delivering high-quality and user-friendly experiences.


** Naming Convention**
- Use a consistent and descriptive naming convention across all projects and components within the mono repo.
- Avoid using ambiguous or generic names that could create confusion or conflicts with other projects or components within the mono repo.
- Package names should be descriptive and easy to remember. For example, a package that contains code for a web server might be named my-web-server.
- Directory names should be similar to package names, but they should be more specific. For example, the directory that contains the code for the web server's main logic might be named src/web-server.
- File names should be descriptive and include the name of the file's contents. For example, a file that contains the code for the web server's main logic might be named main.js.
- Consider using a versioning scheme in the naming convention to indicate the version of the project or component (e.g., "app-v1.0", "lib-v2.3", "ui-v1.2.3", etc.).
- Atomic Design System is a methodology for creating design systems by breaking down the UI into fundamental building blocks called atoms, molecules, and organisms.
- Atoms are the smallest and most basic building blocks, molecules are groups of atoms that work together to form more complex and functional components, and organisms are groups of molecules and atoms that work together to form a more complete section or module of the interface.
- By using Atomic Design System, designers and developers can create scalable, reusable, and consistent components that can be easily maintained and updated.
- This approach promotes a more efficient and collaborative design process by providing a common language and framework for designers and developers to work with, while delivering high-quality and user-friendly experiences.

** Naming Convention**

- Use a consistent and descriptive naming convention across all projects and components within the mono repo.
- Avoid using ambiguous or generic names that could create confusion or conflicts with other projects or components within the mono repo.
- Package names should be descriptive and easy to remember. For example, a package that contains code for a web server might be named my-web-server.
- Directory names should be similar to package names, but they should be more specific. For example, the directory that contains the code for the web server's main logic might be named src/web-server.
- File names should be descriptive and include the name of the file's contents. For example, a file that contains the code for the web server's main logic might be named main.js.
- Consider using a versioning scheme in the naming convention to indicate the version of the project or component (e.g., "app-v1.0", "lib-v2.3", "ui-v1.2.3", etc.).


<p align="right"><a href="#-turbo-frontend-skeleton">⬆️</a></p>

</details>


## Installation:

<details><summary><b>Instructions for installing the project</b></summary>

<br>Open a command prompt or terminal window on your local computer. Navigate to the directory where you want to clone the repository.
<br>Open a command prompt or terminal window on your local computer. Navigate to the directory where you want to clone the repository.

1. Use the **`git clone`** command to clone the repository. The syntax is as follows:

```jsx
git clone git@github.com:wesionaryTEAM/turbo-frontend-skeleton.git
git clone https://github.com/SanjeebLama/frontend-skeleton.git
```

2. Go inside `turbo-frontend-skeleton` folder
2. Go inside `frontend-skeleton` folder

```jsx
cd turbo-frontend-skeleton
cd frontend-skeleton
```

3. Checkout to `develop` branch
Expand All @@ -266,75 +261,60 @@ git checkout develop

4. Make sure to select the appropriate version of Node.js by using `nvm use` If you haven't installed nvm yet, you can follow the installation instructions at the [**official nvm repository on GitHub**](https://github.com/nvm-sh/nvm#installing-and-updating). This step is important to ensure that the project uses the correct version of Node.js and to avoid any potential compatibility issues.


5. After that you’ll first need to install all the dependencies
5. After that you’ll first need to install all the dependencies

```jsx
yarn install
```

Good Job! 🤗 You successfully installed the skeleton, now we just need to run project.

<p align="right"><a href="#-turbo-frontend-skeleton">⬆️</a></p>

</details>


## Running the project:

<details><summary><b>Show instructions</b></summary>

<br>- To Run **both apps** from root

```jsx
yarn run dev
```

<br>- To run **Web** workspace from root

```jsx
yarn workspace web run dev
yarn run web
```

<br>- To run **Docs** workspace from root

```jsx
yarn workspace docs run dev
yarn run docs
```

<p align="right"><a href="#-turbo-frontend-skeleton">⬆️</a></p>
</details>


## Build:

<details><summary><b>Instructions for building the project</b></summary>

<br>To build all apps and packages, run the following command:

```
cd turbo-frontend-skeleton
cd frontend-skeleton
yarn run build
```

To run apps workspace

```
cd turbo-frontend-skeleton
yarn workspace web run dev
```

To run docs workspace

```
cd turbo-frontend-skeleton
yarn workspace docs run dev
```
<p align="right"><a href="#-turbo-frontend-skeleton">⬆️</a></p>

</details>


## Contribution Guidelines:

<details><summary><b>Guidelines for contributing to the project</b></summary>
<br>

Expand All @@ -346,7 +326,6 @@ yarn workspace docs run dev
<p align="right"><a href="#-turbo-frontend-skeleton">⬆️</a></p>
</details>


## Useful Links:

<details><summary><b>Useful resources related to the project </b></summary>
Expand All @@ -355,10 +334,9 @@ yarn workspace docs run dev

- [Documentation](https://www.notion.so/Frontend-Skeleton-Documentation-adac91e528a0498fb3e9316c86f3183b)
- [Checklist](https://www.notion.so/Frontend-Skeleton-Dependencies-Checklist-82baa48de70f4e25aab67f501fb70358)
- [Jira Board](https://wesionary-team.atlassian.net/jira/software/projects/FR/boards/58)

**Learn more about the power of Turborepo:**

- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
Expand Down
6 changes: 4 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
"build": "turbo run build",
"dev": "turbo run dev",
"lint": "turbo run lint",
"format": "prettier --write \"**/*.{ts,tsx,md}\""
"format": "prettier --write \"**/*.{ts,tsx,md}\"",
"web": "turbo run dev --scope=web",
"docs": "turbo run dev --scope=docs"
},
"devDependencies": {
"eslint-config-custom": "*",
Expand All @@ -22,4 +24,4 @@
},
"dependencies": {},
"packageManager": "[email protected]"
}
}
11 changes: 10 additions & 1 deletion turbo.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,19 @@
"!.next/cache/**"
]
},
"dev": {
"cache": false
},
"lint": {
"outputs": []
},
"dev": {
"web": {
"cache": false
},
"docs": {
"cache": false
},
"storybook": {
"cache": false
}
}
Expand Down

0 comments on commit 369a193

Please sign in to comment.