ndagi-nodenext-api
v1.0.4
Published
This package provides a simple and flexible command-line tool to generate a boilerplate API template for both Node.js and Next.js projects. It streamlines the process of setting up a server-side API by scaffolding the essential files and configurations, a
Maintainers
Readme
Ndagi NodeNext Api
Ndagi NodeNext Apiis a command-line tool that helps you quickly generate a server-side API template for both Node.js and Next.js projects. Whether you're building a backend API with Node.js or a full-stack application with Next.js, this package streamlines the process of setting up the essential API files, folder structure, and configurations.
Features
- Express Server Setup: Generates a pre-configured Express server for Node.js.
- Next.js API Routes: Quickly scaffold API routes for seamless integration with Next.js.
- Customizable Templates: Tailor the generated structure to fit your project needs.
- Initializes a Git repository and installs dependencies
- Rapid Setup: Skip repetitive configuration steps and get your project started in minutes.
Installation
Option 1: Install Globally via npm
To install the package globally, use the following command:
npm install -g ndagi-nodenext-apiAfter installation, you can generate the API template by running:
ndagi-nodenext-api new-projectOption 2: Run via npx (No Installation Required)
If you don't want to install the package globally, you can run it directly via npx. This is a great option if you prefer not to globally install dependencies:
npx ndagi-nodenext-api new-projectAdditional Configurations
NodeJS with Typescript
After installing the package, you would need to register and setup your MongoDB online and then copy and paste your MonoDB database url and port number in your .env file as shown below.
DATABASE_URL="your MonoDB database url"
PORT=8001NextJS with Typescript
After installing the package, you would need to register and setup your MongoDB online and then copy and paste your MonoDB database url and next public base url in your .env file as shown below.
DATABASE_URL="your MonoDB database url"
NEXT_PUBLIC_BASE_URL="next public base url"Detailed Configuration
Detailed Configuration is available at:
[Configuration guide here: ](https://www.notion.so/Prisma-MongoDB-Setup-143a87d7c80780969de1fcb6971da098)Live Project
Below is a link for the live project
[Live project testing here: ](https://nextts-api.vercel.app/)License
This project is licensed under the MIT License.
