🚀 CLI tool to create a Next.js project connected to Walacor database 🌐
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.
- 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.
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>
During the setup process, you will be prompted to choose whether to include the following tools and configurations:
> Would you like to add ESLint? (no / yes) › (yes)
> Would you like to add Prettier? (no / yes) › (yes)
> Would you like to add Playwright testing? (no / yes) › (yes)
> Would you like to add a CI/CD pipeline? (no / yes) › (yes)
The CLI tool will configure the project based on your selections, including updating the package.json
file with the appropriate dependencies and scripts.
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
------------------------------------------------------
To run the project, you will need to create a .env
file with the following keys (replace with your own values):
NEXT_PUBLIC_EC2_WALACOR="YOUR_EC2_INSTANCE_IPV4"
NEXT_PUBLIC_WALACOR_BLOG_ETID="YOUR_SCHEMA_ETID"
NEXT_PUBLIC_WALACOR_USERNAME="YOUR_USERNAME"
NEXT_PUBLIC_WALACOR_PASSWORD="YOUR_PASSWORD"
NEXT_PUBLIC_THIRDWEB_CLIENT_ID="YOUR_CLIENT_ID"
NEXT_PUBLIC_THIRDWEB_SECRET_KEY="YOUR_SECRET"
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_BUCKET"
This package is written in TypeScript, ensuring type safety and better code quality. The TypeScript code is compiled to JavaScript for execution.
MIT License
- Next.js
- ESLint
- Prettier
- Playwright
- CI/CD
- CLI
- Project Setup
- Walacor
- JavaScript
- TypeScript