adonisjs-boilerplate

Tech stack

Requirements

• Node >= 20
• pnpm
• postgresql
• Docker

Development

• (ℹ️ only for first setup) Create manually your DB via psql or TablePlus
• Open psql console: psql postgres
• Create DB: CREATE DATABASE db_name;
• Grant privileges to your DB: GRANT ALL PRIVILEGES ON DATABASE db_name TO your_user;
• Run ./scripts/reset-db to setup database and seed
• Run ./scripts/dev to start development server

Testing

• (ℹ️ only for first setup) Create manually your DB via psql or TablePlus
• Open psql console: psql postgres
• Create DB: CREATE DATABASE db_name;
• Grant privileges to your DB: GRANT ALL PRIVILEGES ON DATABASE db_name TO your_user;
• Run ./scripts/test to start test suites

Mailer in development

• We use Mailcatcher through Docker as the mailer previewer for development only
• Run the dev script and Mailcatcher interface is available on http://0.0.0.0:1080/

Tools

• Oxlint
• Oxfmt
• Mailcatcher