🚀 Create AdonisJS 6 PostgreSQL

A powerful CLI wrapper developed by CIDROY-Tech for internal use within our organization. This tool quickly scaffolds a new AdonisJS 6 project with PostgreSQL, JWT authentication, and logging service pre-configured out of the box.

✨ Features Out of the Box

• 🎯 AdonisJS 6 - Latest version with modern architecture
• 🐘 PostgreSQL - Pre-configured database setup and connection
• 🔐 JWT Token Authentication - Complete auth system ready to use
• 📝 Logger Service - Professional logging capabilities built-in
• 🔑 Auto Configuration - Generates APP_KEY automatically
• 🗄️ Database Setup - Creates .env with project-specific database name
• 📦 Package Configuration - Updates package.json with your project name
• 🎨 Beautiful CLI - Interactive prompts with ASCII art
• 🏢 Enterprise Ready - Built for production use in tech organizations

🚀 Quick Start

Recommended Usage with npx:

npx @tech_cidroy/create-adonis6-postgres

This is the preferred method as it ensures you always use the latest version without global installation.

📋 What it does

1. Prompts for project name - Interactive CLI to get your project details
2. Clones starter template - Downloads the AdonisJS PostgreSQL starter from GitHub
3. Configures environment - Creates .env file with database name based on your project
4. Updates package.json - Sets the correct package name for your project
5. Installs dependencies - Runs npm install automatically
6. Generates app key - Creates a secure APP_KEY for your application
7. Ready to go! - Your project is ready for development

📁 Project Structure

After running the command, you'll get a project structure like:

my-adonis-app/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── middleware/
│   └── services/
├── config/
├── database/
│   ├── migrations/
│   └── seeders/
├── start/
├── .env
├── package.json
└── ace

🔧 Development

After project creation, navigate to your project and start development:

cd your-project-name
npm run dev

🗃️ Database Setup

The tool automatically:

• Creates a .env file with database configuration
• Generates a database name based on your project name (sanitized)
• Sets up PostgreSQL connection strings

Make sure to:

1. Have PostgreSQL installed and running
2. Create the database mentioned in your .env file
3. Run migrations: node ace migration:run
4. Run seeders: node ace db:seed ( optional )

📝 Environment Variables

The generated .env file includes:

NODE_ENV=development
PORT=3333
APP_KEY=<auto-generated>
DB_CONNECTION=pg
DB_HOST=127.0.0.1
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=
DB_DATABASE=your_project_name

🤝 Contributing

We welcome contributions! Please see our contributing guidelines.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License.

🆘 Support

If you encounter any issues:

1. Check the starter template repository
2. Open an issue on GitHub
3. Contact us at [email protected]

🙏 Acknowledgments

• AdonisJS - The amazing Node.js framework
• PostgreSQL - The world's most advanced open source database