Alpha Tower Sales System 🏆

A robust RESTful API built with Node.js and TypeScript for managing sales proposals, products, and client relationships

📋 Table of Contents

Overview
Features
Technology Stack
Architecture
Prerequisites
Installation
Configuration
Usage
API Documentation
Database Schema
Testing
Project Structure
Contributing
License

🔍 Overview

Alpha Tower Sales System is a comprehensive API solution designed to streamline sales operations through efficient management of products and user accounts. Built with modern technologies and following clean architecture principles, it provides a scalable foundation for sales-oriented applications.

Key Capabilities

User Management: Complete CRUD operations with authentication and authorization
Product Catalog: Comprehensive product management with inventory tracking
Authentication: JWT-based security with token management
File Upload: Avatar and file management with AWS S3 integration ready
Data Validation: Robust input validation using Joi/Celebrate
Database Management: TypeORM with PostgreSQL and migration support

✨ Features

🔐 Authentication & Authorization

JWT token-based authentication
Secure password hashing with bcryptjs
Protected routes with middleware authentication
User session management

👥 User Management

User registration and profile management
Avatar upload and management
User authentication and authorization
Complete CRUD operations

📦 Product Management

Product catalog with full CRUD operations
Inventory tracking with quantity management
Product categorization and description
Price management with decimal precision

🛡️ Security & Validation

Input validation with Celebrate/Joi
CORS support for cross-origin requests
Error handling with custom AppError class
SQL injection protection through TypeORM

📁 File Management

File upload with Multer
Avatar management system
Static file serving
AWS SDK integration ready

🛠 Technology Stack

Core Technologies

Node.js - JavaScript runtime environment
TypeScript - Type-safe JavaScript superset
Express.js - Web application framework
TypeORM - Object-Relational Mapping library
PostgreSQL - Relational database system

Key Dependencies

Authentication: JWT, bcryptjs
Validation: Celebrate, Joi
File Upload: Multer, AWS SDK
Development: ts-node-dev, ESLint, Prettier
Testing: Jest, Supertest

🏗 Architecture

The application follows a modular architecture with clear separation of concerns:

├── src/
│   ├── modules/           # Business logic modules
│   │   ├── users/         # User management
│   │   └── products/      # Product management
│   ├── shared/            # Shared utilities and infrastructure
│   │   ├── http/          # Express server configuration
│   │   ├── middlewares/   # Custom middleware
│   │   └── errors/        # Error handling
│   ├── config/            # Application configuration
│   ├── database/          # Database setup and migrations
│   └── routes/            # Route definitions

Design Patterns

Repository Pattern: Data access abstraction
Service Layer: Business logic encapsulation
Dependency Injection: Loose coupling between components
Error Handling: Centralized error management

📋 Prerequisites

Before running this project, ensure you have the following installed:

Node.js (v14.0.0 or higher)
npm or yarn package manager
PostgreSQL (v12.0 or higher)
Git for version control

🚀 Installation

1. Clone the Repository

git clone https://github.com/fernandobritto/Alpha-Tower.git
cd Alpha-Tower

2. Install Dependencies

# Using yarn (recommended)
yarn install

# Or using npm
npm install

3. Database Setup

Create a PostgreSQL database for the application:

CREATE DATABASE alpha_tower;

4. Environment Configuration

Create a .env file in the root directory with the following variables:

# Server Configuration
SERVER_PORT=8080

# Database Configuration
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=your_username
DB_PASSWORD=your_password
DB_DATABASE=alpha_tower

# JWT Configuration
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRES_IN=1d

# Upload Configuration
UPLOAD_PATH=./uploads

5. Run Database Migrations

# Run all pending migrations
yarn database:run

# Or using npm
npm run database:run

6. Start the Application

# Development mode with hot reload
yarn localhost

# Or using npm
npm run localhost

The server will start on http://localhost:8080 🚀

⚙️ Configuration

Database Configuration

The application uses TypeORM for database management. Create an ormconfig.json file:

{
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  "username": "your_username",
  "password": "your_password",
  "database": "alpha_tower",
  "entities": ["src/modules/**/database/entities/*.ts"],
  "migrations": ["src/database/migrations/*.ts"],
  "cli": {
    "migrationsDir": "src/database/migrations"
  }
}

Upload Configuration

Configure file upload settings in src/config/upload.ts:

export default {
  directory: uploadFolder,
  storage: multer.diskStorage({
    destination: uploadFolder,
    filename: (request, file, callback) => {
      const fileHash = crypto.randomBytes(10).toString('hex')
      const filename = `${fileHash}-${file.originalname}`
      callback(null, filename)
    },
  }),
}

📖 Usage

Starting the Server

# Development mode
yarn localhost

# Production mode
yarn start

Database Operations

# Run migrations
yarn database:run

# Revert last migration
yarn database:revert

# Sync database schema
yarn database:sync

Code Quality

# Run linting
yarn lint

# Fix linting issues
yarn lint-fix

# Run tests
yarn test

# Run tests with coverage
yarn test:coverage

📚 API Documentation

The API provides the following endpoints:

Authentication

POST /sessions - User login and token generation

Users

GET /users - List all users (authenticated)
GET /users/:id - Get user by ID (authenticated)
POST /users - Create new user
PUT /users/:id - Update user (authenticated)
DELETE /users/:id - Delete user (authenticated)
PATCH /users/avatar - Upload user avatar (authenticated)

Products

GET /products - List all products (authenticated)
GET /products/:id - Get product by ID (authenticated)
POST /products - Create new product (authenticated)
PUT /products/:id - Update product (authenticated)
DELETE /products/:id - Delete product (authenticated)

For detailed API documentation, see docs/API.md.

🗄️ Database Schema

Users Table

CREATE TABLE users (
  id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
  name VARCHAR NOT NULL,
  email VARCHAR UNIQUE NOT NULL,
  password VARCHAR NOT NULL,
  avatar VARCHAR,
  created_at TIMESTAMP DEFAULT NOW(),
  updated_at TIMESTAMP DEFAULT NOW()
);

Products Table

CREATE TABLE products (
  id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
  name VARCHAR NOT NULL,
  description VARCHAR,
  price DECIMAL(10,2) NOT NULL,
  quantity INTEGER NOT NULL,
  created_at TIMESTAMP DEFAULT NOW(),
  updated_at TIMESTAMP DEFAULT NOW()
);

For complete database documentation, see docs/DATABASE.md.

🧪 Testing

The project is configured with Jest for testing:

# Run all tests
yarn test

# Run tests in watch mode
yarn test:silent

# Generate coverage report
yarn test:coverage

📁 Project Structure

Alpha-Tower/
├── src/
│   ├── @types/                 # Type definitions
│   ├── config/                 # Configuration files
│   │   ├── auth.ts            # JWT configuration
│   │   └── upload.ts          # File upload configuration
│   ├── database/              # Database setup
│   │   ├── index.ts          # Database connection
│   │   └── migrations/       # Database migrations
│   ├── modules/               # Business modules
│   │   ├── products/         # Product management
│   │   │   ├── controllers/  # Request handlers
│   │   │   ├── database/     # Entities and repositories
│   │   │   ├── routes/       # Route definitions
│   │   │   └── services/     # Business logic
│   │   └── users/            # User management
│   │       ├── controllers/  # Request handlers
│   │       ├── database/     # Entities and repositories
│   │       ├── routes/       # Route definitions
│   │       └── services/     # Business logic
│   ├── routes/                # Main route configuration
│   └── shared/                # Shared utilities
│       ├── errors/           # Error handling
│       ├── http/             # Server configuration
│       └── middlewares/      # Custom middleware
├── docs/                      # Documentation
├── resource/                  # Static resources
├── package.json              # Dependencies and scripts
├── tsconfig.json             # TypeScript configuration
├── jest.config.js            # Testing configuration
└── README.md                 # Project documentation

🤝 Contributing

Fork the project
Create your feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'Add some AmazingFeature')
Push to the branch (git push origin feature/AmazingFeature)
Open a Pull Request

Development Guidelines

Follow TypeScript best practices
Use meaningful commit messages
Add tests for new features
Update documentation as needed
Run linting before committing

📄 License

This project is licensed under the ISC License - see the LICENSE file for details.

👨‍💻 Author

Fernando Britto

LinkedIn: Fernando Britto
GitHub: @fernandobritto

🙏 Acknowledgments

Node.js community for excellent tooling
TypeORM team for the robust ORM solution
Express.js for the minimal and flexible framework
All contributors who help improve this project

⭐ If you found this project helpful, please give it a star! ⭐

Name		Name	Last commit message	Last commit date
Latest commit History 21 Commits
docs		docs
resource		resource
scripts		scripts
src		src
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.example		.env.example
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.prettierrc		.prettierrc
Dockerfile		Dockerfile
README.md		README.md
docker-compose.yml		docker-compose.yml
jest.config.js		jest.config.js
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

fernandobritto/Alpha-Tower

Folders and files

Latest commit

History

Repository files navigation