Skip to content

gqtpe/trello

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TRELLO

Transforming Ideas into Action, Effortlessly



Built with the tools and technologies:

JSON Markdown npm Chromatic Puppeteer React Yarn Webpack TypeScript Formik Axios Redux Sass Storybook Jest


Table of Contents


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

git clone https://github.com/gqtpe/trello

2. Navigate to the project directory

cd trello

3. Install dependencies

Using npm:

npm install

Using Yarn:

yarn install

Usage

Run the project in development

Using npm:

npm start

Using Yarn:

yarn start

Build for production

npm run build
# or
yarn build

Preview the production build

npm run preview
# or
yarn preview

Testing

Trello uses the {test_framework} test framework. Run the test suite with:

Using npm:

npm test

Using Yarn:

yarn test

(Note: replace {test_framework} with the actual tool you're using, e.g., Vitest, Jest, etc.)