README.md
🔥 Welcome to Blazex
Blazex is an opinionated and blazing-fast 🚀 project starter package for building Node.js APIs with TypeScript, Express.js, and Mongoose.
Get ready to supercharge your development workflow with a solid foundation and industry best practices baked right in!
☄️ Setting Up a New Project with Blazex
Blazex makes it super easy to kick-start your next Node.js API project. With just a single command, you can generate a brand-new project with a battle-tested structure and all the essential dependencies pre-installed. Let's get started!
Step 1: Open your terminal 🖥️
Fire up your favorite terminal application and navigate to the directory where you want to create your new project.
Step 2: Run the blazex command 🚀
In your terminal, run the following command:
npx blazex <project-name>
Replace <project-name>
with the desired name for your project. For example:
npx blazex my-awesome-api
Step 3: Watch the magic happen! ✨
Sit back and watch as blazex works its magic! It will create a new directory with the specified project name and set up the entire project structure for you.
Step 4: Navigate to your project directory 📂
Once the installation is complete, navigate into your newly created project directory:
cd <project-name>
Step 5: Start the development server 🚀
To start the development server and see your new Blazex powered API in action, run the following command:
npm run dev
This will start the server in development mode, with hot-reloading enabled for a smooth coding experience.
Documentation 📄
For detailed information on getting started with Blazex, setting up your project, and understanding the core features and architecture, please refer to the official documentation:
https://blazex.deepak.codes/
Get started with Blazex today and experience blazing-fast 🔥 Node.js API development! If you have any questions or need further assistance, don't hesitate to reach out or create an issue on the GitHub repository.