API boilerplate templates
Last updated
Last updated
Parent repo:
Three (3) API boilerplate templates to choose from i.e. typescript, es module, or common js templates (a.k.a. ts, esm, cjs) for your nodejs mongoDB development, depending on your preference.
API boilerplate templates now use the MVC architecture pattern i.e. separated route, model, controller, and service files.
Development environment already set up with @babel (for esm template only), eslint, and server watch.
The default connection setup type is MongoDB Atlas. You get to choose if you want to use Atlas or switch to the Local mongoDB connection setup type, and you also get to save your preferred connection setup type for when next you run the automated development server.
Improved user experience with the newly added walk-through prompts in the terminal: quick to setup, easy to use, with automated and improved user support.
Follow the instructions on the node-mongo CLI npm package to generate your preferred API boilerplate template:
Step 1
Install dependencies:
Step 2
Ensure you have internet connection
Have a monogDB atlas cluster set up in the cloud
Get your atlas mongoDB uri string
Step 3
Rename the .env.example file to .env
Change PORT_ATLAS environment variable to your preferred port number in the .env file
Add your atlas mongoDB uri string to the MONGODB_ATLAS_URI environment variable in the .env file
Step 4
Start the automated development server and choose ATLAS connection:
Step 4 (alternative)
You can also use the (manual) development server alternative for connection to mongoDB atlas:
npm run dev is the command that starts the automated development server. It prompts you to choose your preferred connection setup type the first time you use it, and saves the chosen connection setup type for every other time you come back to use it. It also automatically installs or set up the db and server files for the chosen connection setup type.
npm run dev:restore resets the automated development server back to first time usage condition i.e. it removes your previously saved connection setup type and the development server will now assume that you are a first timer. After using this command, you will now have the option to set your preferred connection type again the next time you start the server with the npm run dev command.
npm run dev:change is useful for when you are not a first time user and want to change your connection set up type without restoring the automated development server to first time usage condition. It will prompt you to choose your connection setup type, but it will not install the db and server files for the chosen connection setup type.
A demo setup (i.e. collection, endpoints etc) already exists to help you get started with using the node-mongo API boilerplate templates. Running the demo setup will help you understand how to create your own collection endpoints etc. The API design and API call requests and responses sections below will help you understand how the demo setup works.
GET /demo
Get all demo items in the database
No Request Body
POST /demo
Create/add new demo item to the database
name, age
GET /demo/:demoId
Get a demo item stored in the database by its ID
No Request Body
PATCH /demo/:demoId
Update the value of one property of an already existing demo item in the database, using the demo item's ID
propName, value
PUT /demo/:id
Update all properties of an existing demo item in the database, using the demo item's ID
name, age
DELETE /demo/:demoId
Delete a demo item from the database, using the demo item's ID
No request body
