Getting Started

The Ellemment Stack is a full-featured Remix application template designed to get you up and running quickly with a production-ready application.

Quick Start

Create a new project using npx:

npx create-ellemment-app@latest

The CLI will:

1. Prompt for your project name
2. Create a new directory
3. Initialize the project
4. Install dependencies
5. Set up configuration

Development Setup

1. Navigate to your project:

cd your-project-name

2. Initial setup:

npm run setup

3. Start development server:

npm run dev

Your application will be available at http://localhost:3000.

Configuration Options

Skip certain setup steps using environment variables:

# Unix/Mac
SKIP_SETUP=true SKIP_FORMAT=true SKIP_DEPLOYMENT=true npx create-ellemment-app@latest
,[object Object],
set SKIP_SETUP=true && set SKIP_FORMAT=true && set SKIP_DEPLOYMENT=true && npx create-ellemment-app@latest

Available options:

• SKIP_SETUP: Skip running npm run setup
• SKIP_FORMAT: Skip running npm run format
• SKIP_DEPLOYMENT: Skip deployment setup

Development Account

The setup process creates a development account:

• Username: ellemmentadmin
• Password: ellemmentadmin

Documentation Overview

The Ellemment Stack provides comprehensive documentation to help you build and deploy your application:

Core Documentation

• Features - Built-in features and capabilities
• Deployment - Deployment configuration and steps
• Database - Database setup and management
• Authentication - User authentication and authorization

Best Practices

• Guiding Principles - Core principles and philosophy
• Security - Security best practices and configurations
• Performance - Performance optimization guidelines
• Testing - Testing strategies and tools

Maintenance

• Managing Updates - Keeping your application up-to-date
• Monitoring - Application monitoring and logging
• Troubleshooting - Common issues and solutions

Examples and Resources

• Examples - Real-world implementation examples
• Community - Community resources and contributions

Next Steps

1. Review the features documentation to understand available capabilities
2. Set up deployment for your application
3. Explore examples for implementation patterns
4. Join the community to share and learn

Development Best Practices

1. Version Control:

   • Commit early and often
   • Follow conventional commits
   • Use feature branches

2. Testing:

   • Write tests for new features
   • Run test suite before commits
   • Maintain test coverage

3. Code Quality:

   • Use TypeScript strictly
   • Follow ESLint rules
   • Maintain consistent formatting

4. Deployment:

   • Set up staging environment
   • Configure monitoring
   • Implement CI/CD pipeline

For more detailed information about any aspect of development, refer to the respective documentation sections linked above.