Skip to content

lishine/assignment-no-tr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Polygons App

Quick Start

Installation

# 1. Clone the repository
git clone <repository-url>
cd assignment-no-tr

cd app
pnpm install

cd backend
pnpm install

cd "frontend"
pnpm install

Running the Application

Backend:

pnpm docker:up
cd backend
pnpm dev

🌐 API Documentation: http://localhost:3100/

🌐 Postgress Client: http://localhost:8080/

Frontend:

cd frontend
pnpm dev

🎨 Application: http://localhost:3000

Testing

Test Type Command Description
🧪 Unit Tests pnpm test Run comprehensive test suites
🔌 API Tests Multiple formats cURL, HTTPie, Insomnia, VSCode REST app/backend/api-tests/
🎯 Vitest Extension IDE Integration Real-time test execution

Development

💡 Pro Tip: Install recommended VSCode extensions for the best development experience

Backend Architecture

Built on the robust Express TypeScript Boilerplate by GeekyAnts

Architecture Highlights

🎯 Modular Design

  • 🛣️ Routes - API endpoint definitions
  • 🎮 Controllers - Request/response handling
  • ⚙️ Services - Business logic layer
  • 🗄️ Repositories - Data access layer

🛡️ Built-in Middleware

  • 📝 Request logging
  • ❌ Error handling
  • 🚦 Rate limiting

Frontend Architecture

Technology Choices

🏗️ Build Tool (rspack)

  • ⚡ Lightning-fast build speeds
  • 🌟 Excellent community support
  • 🔧 Comprehensive capabilities

⚛️ Framework (React)

  • 🌍 Widespread adoption
  • 🏗️ Rich ecosystem
  • 👥 Developer familiarity

💅 Styling (styled-jsx)

  • 🎯 Component-scoped styling
  • 🤖 AI-supported
  • 🔧 Rsbuild integration

Built with ❤️ using modern web technologies

TypeScript • React • Express.js • OpenAPI • Vitest

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors