https://github.com/raniellimontagna/quantun
Quantum Monorepo created to optimize and standardize reusable code.
https://github.com/raniellimontagna/quantun
changesets monorepo react turborepo typescript
Last synced: 4 months ago
JSON representation
Quantum Monorepo created to optimize and standardize reusable code.
- Host: GitHub
- URL: https://github.com/raniellimontagna/quantun
- Owner: RanielliMontagna
- License: other
- Created: 2022-09-07T15:43:36.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T11:34:46.000Z (almost 2 years ago)
- Last Synced: 2025-09-13T08:42:35.598Z (5 months ago)
- Topics: changesets, monorepo, react, turborepo, typescript
- Language: TypeScript
- Homepage:
- Size: 847 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Quantun
About
|
Technologies
|
Getting started
| License
## 📖 About
Quantun is a monorepo for managing projects using React and Typescript.It uses [Turborepo](https://turborepo.org/) to manage the monorepo and [Storybook](https://storybook.js.org/) to manage the UI components. It was created to facilitate the creation of new projects, as well as to facilitate the maintenance of these projects.
## ⚡ Technologies
Quantun uses the following technologies:
- [Turborepo](https://turborepo.org/) - Monorepo manager
- [React](https://reactjs.org/) - Library for building user interfaces
- [Typescript](https://www.typescriptlang.org/) - Superset of Javascript
- [Storybook](https://storybook.js.org/) - Library for building UI components
- [Jest](https://jestjs.io/) - Library for testing
- [Prettier](https://prettier.io/) - Code formatter for Javascript
- [ESLint](https://eslint.org/) - Linter for identifying and reporting on patterns in JavaScript
- [Changesets](https://github.com/changesets/changesets) - Library for managing changelogs and versions
Also, Quantun uses [PNPM](https://pnpm.io/) as package manager.
## 🚀 Getting started
### 📋 Install
To install the project dependencies, run the command:
```bash
yarn
```
### 🏃 Run and develop
To run and view the project, run the command:
```bash
yarn dev
```
Access the storybook through the address: http://localhost:6006
### 📝 Format
To format the code, run the command:
```bash
yarn format
```
### ☁️ Clean
To clean the project, run the command:
```bash
yarn clean
```
### 🧪 Tests
To run the tests, run the command:
```bash
yarn test
```
### 🏗️ Build
To generate the project build, run the command:
```bash
yarn build
```
### 📦 Publish
There are two ways to publish the project:
- Manual publication: To publish the project manually, run the command: `yarn release`
- Automatic publication: To publish the project automatically, it is necessary to push the master branch. Github Actions will execute the publication process.
]
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
#### Made with ❤️ by [Ranielli Montagna](https://github.com/RanielliMontagna)