https://github.com/gqtpe/trello
todolist trello like app with authorization,
https://github.com/gqtpe/trello
auth-token axios chromatic custom-hooks feature-based formik gh-pages jest mui-material react redux reduxtoolkit rest-api router-dom storybook trello-clone typescript
Last synced: 2 months ago
JSON representation
todolist trello like app with authorization,
- Host: GitHub
- URL: https://github.com/gqtpe/trello
- Owner: gqtpe
- Created: 2024-05-28T06:06:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T14:31:55.000Z (over 1 year ago)
- Last Synced: 2025-04-08T22:46:32.181Z (about 1 year ago)
- Topics: auth-token, axios, chromatic, custom-hooks, feature-based, formik, gh-pages, jest, mui-material, react, redux, reduxtoolkit, rest-api, router-dom, storybook, trello-clone, typescript
- Language: TypeScript
- Homepage: https://gqtpe.github.io/trello/
- Size: 5.08 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TRELLO
*Transforming Ideas into Action, Effortlessly*
[]()
[]()
[]()
_Built with the tools and technologies:_
---
## Table of Contents
- [Overview](#overview)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Testing](#testing)
---
## Overview
**Trello** is a modern, **React-based** clone of the popular task management platform, built with a focus on scalability, maintainability, and visual consistency.
It leverages **TypeScript** for type safety, **Redux** for state management, and **Storybook** for component documentation and testing.
### Why Trello?
This project empowers developers to build, test, and deploy feature-rich task management applications efficiently. The core features include:
- 🎨 **Visual Testing**: Streamlined visual regression detection with Chromatic, ensuring UI consistency
- 🛠️ **Type Safety**: Robust TypeScript configurations that facilitate reliable, modern JavaScript development
- 📚 **Modular Components**: Reusable, well-documented UI components with Storybook integration
- ⚙️ **State & API Management**: Seamless handling of tasks, lists, and user authentication via Redux and API interactions
- 🔒 **Secure Routing**: Route protection and authentication flows to safeguard user data
---
## Getting Started
### Prerequisites
This project requires the following dependencies:
- **Programming Language**: TypeScript
- **Package Manager**: npm or Yarn
### Installation
Build **trello** from source and install dependencies.
#### 1. Clone the repository
```bash
git clone https://github.com/gqtpe/trello
```
#### 2. Navigate to the project directory
```bash
cd trello
```
#### 3. Install dependencies
Using **npm**:
```bash
npm install
```
Using **Yarn**:
```bash
yarn install
```
---
## Usage
### Run the project in development
Using **npm**:
```bash
npm start
```
Using **Yarn**:
```bash
yarn start
```
### Build for production
```bash
npm run build
# or
yarn build
```
### Preview the production build
```bash
npm run preview
# or
yarn preview
```
---
## Testing
Trello uses the `{test_framework}` test framework. Run the test suite with:
Using **npm**:
```bash
npm test
```
Using **Yarn**:
```bash
yarn test
```
> _(Note: replace `{test_framework}` with the actual tool you're using, e.g., Vitest, Jest, etc.)_