Skip to content

igor-kan/aetherhealth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

aetherhealth

CI Status License: MIT Last Commit Next.js TypeScript Tailwind CSS

Modern web application built with cutting-edge technologies

✨ Features

  • πŸš€ Next.js 15 with App Router for optimal performance
  • πŸ’Ž TypeScript for type safety and enhanced developer experience
  • 🎨 Tailwind CSS for modern, responsive design
  • ⚑ Server-Side Rendering for improved SEO and performance
  • πŸ”§ Modern Development Tools with ESLint, Prettier, and automated workflows

πŸš€ Quick Start

Prerequisites

  • Node.js 20.11.0 or later
  • npm or bun package manager
  • Git version control

Installation

# Clone the repository
git clone https://github.com/igor-kan/aetherhealth.git
cd aetherhealth

# Install dependencies
npm install
# or
bun install

Environment Setup

  1. Copy the environment template:

    cp .env.example .env
  2. Update the .env file with your configuration

Development

# Start development server
npm run dev
# or
bun dev

The application will be available at http://localhost:3000 (or appropriate port).

πŸ“‹ Available Scripts

Command Description
npm run dev Start development server
npm run build Build for production
npm run start Start production server
npm run lint Run ESLint
npm run type-check Run TypeScript compiler

πŸ—οΈ Project Structure

src/
β”œβ”€β”€ components/     # Reusable UI components
β”œβ”€β”€ app/            # Next.js App Router pages
β”œβ”€β”€ lib/            # Utility functions
β”œβ”€β”€ hooks/          # Custom React hooks
β”œβ”€β”€ types/          # TypeScript type definitions
└── styles/         # Global styles
public/             # Static assets
__tests__/          # Test files

🌐 Deployment

GitHub Pages

npm run deploy

Docker

docker build -t aetherhealth .
docker run -p 3000:3000 aetherhealth

πŸ§ͺ Testing

# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with coverage
npm run test:coverage

🐳 Docker Support

This project includes Docker support for easy deployment.

# Build the image
docker build -t aetherhealth .

# Run with Docker Compose
docker-compose up -d

# View logs
docker-compose logs -f

See DOCKER.md for detailed Docker usage.

πŸ“„ Environment Variables

See .env.example for required environment variables.

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/aetherhealth.git
  3. Create a feature branch: git checkout -b feature/amazing-feature
  4. Install dependencies: npm install
  5. Make your changes and test thoroughly
  6. Commit your changes: git commit -m 'Add amazing feature'
  7. Push to your branch: git push origin feature/amazing-feature
  8. Open a Pull Request

πŸ“ License

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

πŸ™ Acknowledgments

  • Built with modern development tools and best practices
  • Inspired by the open-source community
  • Thanks to all contributors and users

πŸ“ž Support

πŸ”— Links


Made with ❀️ by Igor Kan

Pre-commit Setup

This project uses pre-commit hooks for code quality. To set up:

# Install pre-commit (if not already installed globally)
pip install pre-commit

# Install hooks
pre-commit install

# Or for Node.js projects with Husky:
npm install --save-dev husky lint-staged
npm run prepare

Development with VS Code Dev Containers

This project includes a VS Code dev container configuration for consistent development environments.

Prerequisites

  • Docker Desktop
  • VS Code with Remote-Containers extension

Getting Started

  1. Open the project in VS Code
  2. When prompted, click "Reopen in Container" or use Command Palette: "Remote-Containers: Reopen in Container"
  3. Wait for the container to build and start
  4. All dependencies will be automatically installed

Features

  • Pre-configured development environment
  • All necessary tools and extensions
  • Consistent setup across all machines
  • Isolated development environment

Code Review

This repository uses CODEOWNERS for automatic review requests:

  • All changes require review from repository maintainers
  • Pull requests will automatically request reviews from code owners
  • Critical files (configuration, build, deployment) have additional review requirements

See CODEOWNERS for detailed review assignments.

Repository Configuration

This repository uses .gitattributes for consistent file handling:

  • Line endings: Automatic normalization to LF for text files
  • Binary files: Proper handling of images, fonts, and compiled files
  • Language detection: Accurate GitHub language statistics
  • Generated files: Exclusion of build artifacts from diffs and language stats
  • Cross-platform: Consistent behavior across Windows, macOS, and Linux

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •