create-walacor-app

🚀 CLI tool to create a Next.js project connected to Walacor database 🌐

CLI-Tool

Description

create-walacor-app is a command-line tool that helps you quickly set up a new Next.js project configured with various optional tools like ESLint, Prettier, Playwright, and CI/CD pipelines.

Features

• Next.js: Set up a Next.js project with ease.
• ESLint: Optionally add ESLint for linting your code.
• Prettier: Optionally add Prettier for code formatting.
• Playwright: Optionally add Playwright for end-to-end testing.
• CI/CD: Optionally add a CI/CD pipeline configuration using GitHub Actions.

Installation

You can install create-walacor-app globally using npm:

npm install -g create-walacor-app

Alternatively, you can use npx to run the CLI tool without installing it globally:

npx create-walacor-app <project-name>

Options

During the setup process, you will be prompted to choose whether to include the following tools and configurations:

ESLint

> Would you like to add ESLint? (no / yes) › (yes)

Prettier

> Would you like to add Prettier? (no / yes) › (yes)

Playwright

> Would you like to add Playwright testing? (no / yes) › (yes)

CI/CD

> Would you like to add a CI/CD pipeline? (no / yes) › (yes)

Configuration

The CLI tool will configure the project based on your selections, including updating the package.json file with the appropriate dependencies and scripts.

Successful Installation Example

npx create-walacor-app this-is-my-project
✔ Would you like to add ESLint? … yes
✔ Would you like to add a CI/CD pipeline? … yes
✔ Would you like to add Playwright testing? … yes
✔ Would you like to add Prettier? … yes
------------------------------------------------------

🛠️  Creating a new Next.js project in /Users/username/Desktop/my-new-project

------------------------------------------------------

🔄 Cloning the repository...

Cloning into '/Users/username/Desktop/my-new-project'...

🧹 Cleaning up...

------------------------------------------------------

🌐 Initializing data...

------------------------------------------------------

📦 Installing dependencies...

📦 Adding ESLint...

📦 Adding CI/CD pipeline...

📦 Adding Playwright testing...

📦 Adding Prettier...

------------------------------------------------------
🎉 Project created successfully!
------------------------------------------------------

📄 Next steps:

1. cd /Users/username/Desktop/my-new-project

2. npm run dev

Your project is now ready and running at http://localhost:3000

------------------------------------------------------

Environment Variables

To run the project, you will need to create a .env file with the following keys (replace with your own values):

Walacor

NEXT_PUBLIC_EC2_WALACOR="http://your-ec2-instance-url:port"
NEXT_PUBLIC_WALACOR_USERNAME="your-username"
NEXT_PUBLIC_WALACOR_PASSWORD="your-password"

Walacor ETIDs

NEXT_PUBLIC_WALACOR_BLOG_ETID="your-blog-etid"
NEXT_PUBLIC_WALACOR_PROFILE_ETID="your-profile-etid"
NEXT_PUBLIC_WALACOR_ROLE_ETID="your-role-etid"

AWS

NEXT_PUBLIC_AWS_ACCESS_KEY_ID="your-access-key-id"
NEXT_PUBLIC_AWS_SECRET_ACCESS_KEY="your-secret-access-key"
NEXT_PUBLIC_AWS_REGION="your-region"
NEXT_PUBLIC_AWS_S3_BUCKET="your-s3-bucket-name"

Auth

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="your-publishable-key"
CLERK_SECRET_KEY="your-secret-key"
NEXT_PUBLIC_CLERK_SIGN_IN_URL="/sign-in"
NEXT_PUBLIC_CLERK_SIGN_UP_URL="/sign-up"

TypeScript

This package is written in TypeScript, ensuring type safety and better code quality. The TypeScript code is compiled to JavaScript for execution.

License

MIT License

Keywords

• Next.js
• ESLint
• Prettier
• Playwright
• CI/CD
• CLI
• Project Setup
• Walacor
• JavaScript
• TypeScript

Connect with Us

LinkedIn