 Dominik Kundel 🧑🏫 |
57 |  Academind 🧑🏫 |
58 |  CodAffection 🧑🏫 |
59 |  Cory House 🧑🏫 |
60 |  Joseph Obiagba 🧑🏫 |
61 |  Israel Obiagba 🧑🏫 |
62 |
 Abhishek K M 📖 |
76 |  All Contributors 🚇 |
77 |  Chikezie Joachim 💻 |
78 |  David Oladepo 📖 |
79 |  Festus Ali 💻 |
80 |  Hritik R 📖 💻 |
81 |
 Keithan Philander 🐛 💻 |
84 |  Muhammad Izhar 📖 |
85 |  Obiagba Mary Ifeoma 💻 📖 |
86 |  Obiagba Samuel 💻 🐛 |
87 |  Olaleye Blessing 📖 |
88 |  Rashid 💻 |
89 |
 oyenuga17 💻 |
92 |
84 |
86 | Request body shape 87 |
88 |
92 | Successful response shape 93 |
94 |
112 |
113 |
114 |
115 | GET /demo
85 |86 | Request body shape 87 |
88 |
89 | No request body 90 |91 |
92 | Successful response shape 93 |
94 |
95 | {
96 | "count": number,
97 | "items": [
98 | {
99 | "_id": "string",
100 | "name": "string",
101 | "age": number,
102 | "request": {
103 | "type": "string",
104 | "url": "string"
105 | }
106 | },
107 | // etc.
108 | ]
109 | }
110 |
111 |
116 |
118 | Request body shape 119 |
120 |
127 | Successful response shape 128 |
129 |
144 |
145 |
146 |
147 | POST /demo
117 |118 | Request body shape 119 |
120 |
121 | {
122 | "name": "string",
123 | "age": number
124 | }
125 |
126 | 127 | Successful response shape 128 |
129 |
130 | {
131 | "message": "string",
132 | "newItem": {
133 | "_id": "string",
134 | "name": "string",
135 | "age": number,
136 | "request": {
137 | "type": "string",
138 | "url": "string"
139 | }
140 | }
141 | }
142 |
143 |
148 |
150 | Request body shape 151 |
152 |
156 | Successful response shape 157 |
158 |
171 |
172 |
173 |
174 | GET /demo/:demoId
149 |150 | Request body shape 151 |
152 |
153 | No request body 154 |155 |
156 | Successful response shape 157 |
158 |
159 | {
160 | "_id": "string",
161 | "name": "string",
162 | "age": number,
163 | "request": {
164 | "type": "string",
165 | "description": "string",
166 | "url": "string"
167 | }
168 | }
169 |
170 |
175 |
177 | Request body shape 178 |
179 |
194 |
195 | Successful response shape 196 |
197 |
208 |
209 |
210 |
211 | PATCH /demo/:demoId
176 |177 | Request body shape 178 |
179 |
180 | [
181 | { "propName": "string", "value": "string" }
182 | ]
183 |
184 |
185 | OR
186 |
187 |
188 | [
189 | { "propName": "string", "value": number }
190 | ]
191 |
192 | i.e. propName can be string "name" or "age". Value is a string when name is the propName, while value is a number when age is the propName.
193 | 194 |
195 | Successful response shape 196 |
197 |
198 | {
199 | "message": "string",
200 | "request": {
201 | "type": "string",
202 | "description": "string",
203 | "url": "string"
204 | }
205 | }
206 |
207 |
212 |
214 | Request body shape 215 |
216 |
223 | Successful response shape 224 |
225 |
236 |
237 |
238 |
239 | PUT /demo/:id
213 |214 | Request body shape 215 |
216 |
217 | {
218 | "name": "string",
219 | "age": number
220 | }
221 |
222 | 223 | Successful response shape 224 |
225 |
226 | {
227 | "message": "string",
228 | "request": {
229 | "type": "string",
230 | "description": "string",
231 | "url": "string"
232 | }
233 | }
234 |
235 |
240 |
242 | Request body shape 243 |
244 |
248 | Successful response shape 249 |
250 |
265 |
266 | ## Documentation
267 | See the links to the official documentation of the node-mongo project and community building it below:
268 | - [Node Mongo documentation](https://code-collabo.gitbook.io/node-mongo-v2.0.0)
269 | - [Code Collabo documentation](https://code-collabo.gitbook.io/community-doc-v1.0.0)
270 |
--------------------------------------------------------------------------------
/templates/cjs/node-mongo-helpers.js:
--------------------------------------------------------------------------------
1 | const { spawn } = require('child_process');
2 | const package_json = require('./package.json');
3 | const chalk = require('chalk');
4 |
5 | /* eslint-disable no-console */
6 |
7 | // console
8 | const success = (message) => {
9 | console.log( chalk.greenBright(message) );
10 | }
11 |
12 | const warning = (message) => {
13 | console.log( chalk.yellowBright(message) );
14 | }
15 |
16 | const error = (message) => {
17 | console.log( chalk.redBright(message) );
18 | }
19 |
20 | // DB connect
21 | const watchEslint = () => {
22 | const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
23 | spawn(npm, ['run', 'lint:watch'], { cwd: './', stdio: 'inherit' });
24 | }
25 |
26 | const server = (serverPort) => {
27 | try {
28 | success(`\nnode-mongo (Commonjs Module) API boilerplate template v${package_json.version}`);
29 | success(`\nServer running at ${serverPort}`);
30 | } catch (err) {
31 | error(`${{ err }}`);
32 | }
33 | }
34 |
35 | const eslintAndServer = (serverPort) => {
36 | watchEslint();
37 | server(serverPort);
38 | }
39 |
40 | const afterAtlasDBconnectSuccessful = (serverPort) => {
41 | success('\nConnected to mongoDB ATLAS');
42 | eslintAndServer(serverPort);
43 | }
44 |
45 | const afterLocalDBconnectSuccessful = (serverPort) => {
46 | success('\nConnected to LOCAL mongoDB');
47 | eslintAndServer(serverPort);
48 | }
49 |
50 | const connectToDBunsuccessful = (err) => {
51 | error(`\nError in DB connection: ${err.message}\n`);
52 | warning('Refer to the node-mongo documentation: https://code-collabo.gitbook.io/node-mongo-v2.0.0\n\nGet further help from Code Collabo Community\'s Node mongo channel: https://matrix.to/#/#collabo-node-mongo:gitter.im\n');
53 | }
54 |
55 |
56 | // export all helper functions together
57 | module.exports = {
58 | success,
59 | warning,
60 | error,
61 | watchEslint,
62 | server,
63 | afterAtlasDBconnectSuccessful,
64 | afterLocalDBconnectSuccessful,
65 | connectToDBunsuccessful,
66 | };
67 |
--------------------------------------------------------------------------------
/templates/cjs/node-mongo.js:
--------------------------------------------------------------------------------
1 | import { chooseNodeMongoApiDBServer } from '@code-collabo/node-mongo-scripts/index';
2 |
3 | chooseNodeMongoApiDBServer();
4 |
5 |
--------------------------------------------------------------------------------
/templates/cjs/node-mongo.json:
--------------------------------------------------------------------------------
1 | {
2 | "pathToCheck": "./src",
3 | "templateName": "cjs"
4 | }
5 |
--------------------------------------------------------------------------------
/templates/cjs/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "node-mongo-api-boilerplate-template-cjs",
3 | "version": "1.0.0",
4 | "description": "@code-collabo node-mongo API boilerplate template - common js",
5 | "main": "src/server.[atlas/local].js",
6 | "scripts": {
7 | "dev": "node -r esm node-mongo.js",
8 | "dev:local": "nodemon --exec node src/server.local.js",
9 | "dev:atlas": "nodemon --exec node src/server.atlas.js",
10 | "lint": "esw src --color",
11 | "lint:watch": "npm run lint -- --watch",
12 | "dev:restore": "node -r esm node-mongo.js",
13 | "dev:change": "node -r esm node-mongo.js"
14 | },
15 | "author": "Author Name",
16 | "license": "ISC",
17 | "dependencies": {
18 | "@code-collabo/node-mongo-scripts": "^1.2.0",
19 | "cors": "^2.8.5",
20 | "dotenv": "^16.0.3",
21 | "esm": "^3.2.25",
22 | "express": "^4.18.2",
23 | "mongoose": "^7.0.5",
24 | "morgan": "^1.10.0"
25 | },
26 | "devDependencies": {
27 | "chalk": "^4.1.0",
28 | "eslint": "^8.39.0",
29 | "eslint-plugin-import": "^2.27.5",
30 | "eslint-watch": "^8.0.0",
31 | "nodemon": "^2.0.22"
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/templates/cjs/src/api/controllers/app.controller.js:
--------------------------------------------------------------------------------
1 | const { success } = require('../../../node-mongo-helpers');
2 |
3 | async function getAppController (req, res) {
4 | const message = 'App works!';
5 | success(message);
6 | return res.status(200).json({ message });
7 | }
8 |
9 | module.exports = { getAppController };
10 |
--------------------------------------------------------------------------------
/templates/cjs/src/api/controllers/demo.controller.js:
--------------------------------------------------------------------------------
1 | const {
2 | getDemoItemsService,
3 | createDemoItemService,
4 | getOneDemoItemService,
5 | deleteDemoItemService,
6 | updateOneDemoItemPropertyValueService,
7 | updateDemoItemPropertyValuesService,
8 | } = require('../services/demo.service');
9 | const { success, error } = require('../../../node-mongo-helpers');
10 |
11 | const routeName = 'demo';
12 | const item = `${routeName}-item`;
13 |
14 | let response = {};
15 |
16 | const getDemoItemsController = function (req, res) {
17 | getDemoItemsService()
18 | .then((docs) => {
19 | response = {
20 | count: docs.length,
21 | items: docs.map((doc) => {
22 | return {
23 | _id: doc._id,
24 | name: doc.name,
25 | age: doc.age,
26 | request: {
27 | type: 'GET',
28 | url: `http://localhost:3000/${routeName}/${doc._id}`,
29 | },
30 | };
31 | }),
32 | };
33 | success(`GET request successful!`);
34 | return res.status(200).json(response);
35 | })
36 | .catch((err) => {
37 | error(`Error retriving ${item}s: ${err}`);
38 | res.status(500).json({
39 | error: `${err}`,
40 | });
41 | });
42 | };
43 |
44 | const createDemoItemController = function (req, res) {
45 | createDemoItemService(req)
46 | .then((doc) => {
47 | response = {
48 | message: `${item} created successfully!`,
49 | newItem: {
50 | _id: doc._id,
51 | name: doc.name,
52 | age: doc.age,
53 | request: {
54 | type: 'GET',
55 | url: `http://localhost:3000/${routeName}/${doc._id}`,
56 | },
57 | },
58 | }
59 | success(`${item} CREATED successfully!`);
60 | return res.status(201).json(response);
61 | })
62 | .catch((err) => {
63 | error(`Error saving ${item}: ${err}`);
64 | res.status(500).json({
65 | error: `${err}`,
66 | });
67 | });
68 | };
69 |
70 | const getOneDemoItemController = function (req, res) {
71 | const id = req.params.demoId;
72 | getOneDemoItemService(id)
73 | .then((doc) => {
74 | if (doc) {
75 | response = {
76 | _id: doc._id,
77 | name: doc.name,
78 | age: doc.age,
79 | request: {
80 | type: 'GET',
81 | description: `Url link to all ${item}s`,
82 | url: `http://localhost:3000/${routeName}/`,
83 | },
84 | }
85 | success(`GET request successful!`);
86 | return res.status(200).json(response);
87 | } else {
88 | error('No record found for provided ID');
89 | return res.status(404).json({
90 | message: 'No record found for provided ID',
91 | });
92 | }
93 | })
94 | .catch((err) => {
95 | error(`Error retriving ${item}: ${err}`);
96 | res.status(500).json({
97 | message: 'Invalid ID',
98 | error: `${err}`,
99 | });
100 | });
101 | };
102 |
103 | const deleteDemoItemController = function (req, res) {
104 | const id = req.params.demoId;
105 | deleteDemoItemService(id)
106 | .then(() => {
107 | response = {
108 | message: `${item} deleted successfully!`,
109 | request: {
110 | type: 'POST',
111 | description: 'Url link to make post request to',
112 | url: `http://localhost:3000/${item}/`,
113 | body: {
114 | name: 'String',
115 | age: 'Number',
116 | },
117 | },
118 | }
119 | success(`${item} DELETED successfully!`);
120 | return res.status(200).json(response);
121 | })
122 | .catch((err) => {
123 | error(`Error deleting ${item}: ${err}`);
124 | res.status(500).json({
125 | message: `Error deleting ${item}`,
126 | error: `${err}`,
127 | });
128 | });
129 | };
130 |
131 | const updateOneDemoItemPropertyValueController = function (req, res) {
132 | const id = req.params.demoId;
133 | updateOneDemoItemPropertyValueService(id, req.body)
134 | .then(() => {
135 | response = {
136 | message: 'Patch request successful!',
137 | request: {
138 | type: 'GET',
139 | description: `Url link to updated ${item}`,
140 | url: `http://localhost:3000/${routeName}/${id}`,
141 | },
142 | };
143 | success(`PATCH request for ID ${id} successful!`);
144 | return res.status(200).json(response);
145 | })
146 | .catch((err) => {
147 | error(`Error updating ${item} property & value: ${err}`);
148 | res.status(500).json({
149 | message: `Error updating ${item} property & value`,
150 | error: `${err}`,
151 | });
152 | });
153 | };
154 |
155 | const updateDemoItemPropertyValuesController = function (req, res) {
156 | const id = req.params.id;
157 | updateDemoItemPropertyValuesService(id, req.body)
158 | .then(() => {
159 | response = {
160 | message: `Put request successful!`,
161 | request: {
162 | type: 'GET',
163 | description: `Url link to updated ${item}`,
164 | url: `http://localhost:3000/${routeName}/${id}`,
165 | },
166 | };
167 | success(`PUT request for ID ${id} successful!`);
168 | return res.status(200).json(response);
169 | })
170 | .catch((err) => {
171 | error(`Error updating ${item}: ${err}`);
172 | res.status(500).json({
173 | message: `Error updating ${item}`,
174 | error: `${err}`,
175 | });
176 | });
177 | };
178 |
179 | module.exports = {
180 | getDemoItemsController,
181 | createDemoItemController,
182 | getOneDemoItemController,
183 | deleteDemoItemController,
184 | updateOneDemoItemPropertyValueController,
185 | updateDemoItemPropertyValuesController,
186 | };
187 |
--------------------------------------------------------------------------------
/templates/cjs/src/api/models/demo.model.js:
--------------------------------------------------------------------------------
1 | const mongoose = require('mongoose');
2 |
3 | const collectionName = 'demo';
4 |
5 | const DemoSchema = mongoose.Schema({
6 | name: { type: String, required: true },
7 | age: { type: Number, required: true }
8 | });
9 |
10 | const DemoModel = mongoose.model(collectionName, DemoSchema, collectionName); //declare collection name a second time to prevent mongoose from pluralizing or adding 's' to the collection name
11 |
12 | module.exports = DemoModel;
13 |
--------------------------------------------------------------------------------
/templates/cjs/src/api/routes/app.route.js:
--------------------------------------------------------------------------------
1 | const express = require('express');
2 | const { getAppController} = require('../controllers/app.controller');
3 |
4 | const router = express.Router();
5 |
6 | router.get('/', getAppController);
7 |
8 | module.exports = router;
9 |
--------------------------------------------------------------------------------
/templates/cjs/src/api/routes/demo.route.js:
--------------------------------------------------------------------------------
1 | const express = require('express');
2 | const {
3 | getDemoItemsController,
4 | createDemoItemController,
5 | getOneDemoItemController,
6 | deleteDemoItemController,
7 | updateOneDemoItemPropertyValueController,
8 | updateDemoItemPropertyValuesController,
9 | } = require('../controllers/demo.controller');
10 |
11 | const router = express.Router();
12 |
13 | router.get('/', getDemoItemsController);
14 | router.post('/', createDemoItemController);
15 | router.get('/:demoId', getOneDemoItemController);
16 | router.delete('/:demoId', deleteDemoItemController);
17 | router.patch('/:demoId', updateOneDemoItemPropertyValueController);
18 | router.put('/:id', updateDemoItemPropertyValuesController);
19 |
20 | module.exports = router;
21 |
--------------------------------------------------------------------------------
/templates/cjs/src/api/services/demo.service.js:
--------------------------------------------------------------------------------
1 | const Demo = require('../models/demo.model');
2 |
3 | /* eslint-disable no-extra-semi */ // Note: only cjs api template needs this particular eslint comment
4 |
5 | function getDemoItemsService () {
6 | const query = Demo.find().select('_id name age').exec();
7 | return query;
8 | };
9 |
10 | function createDemoItemService (req) {
11 | const demo = new Demo({
12 | name: req.body.name,
13 | age: req.body.age,
14 | });
15 | return demo.save();
16 | };
17 |
18 | function getOneDemoItemService (paramsId) {
19 | const query = Demo.findById(paramsId).select('_id name age').exec();
20 | return query;
21 | };
22 |
23 | function deleteDemoItemService (paramsId) {
24 | const query = Demo.deleteOne({ _id: paramsId }).exec();
25 | return query;
26 | };
27 |
28 | function updateOneDemoItemPropertyValueService (paramsId, requestBody) {
29 | const updateOps = {};
30 | for (const ops of requestBody) {
31 | updateOps[ops.propName] = ops.value;
32 | }
33 | const query = Demo.updateOne({ _id: paramsId }, { $set: updateOps }).exec();
34 | return query;
35 | };
36 |
37 | function updateDemoItemPropertyValuesService (paramsId, requestBody) {
38 | const resetItem = {
39 | name: requestBody.name,
40 | age: requestBody.age,
41 | };
42 | const query = Demo.findByIdAndUpdate(paramsId, { $set: resetItem }, { new: true }).exec();
43 | return query;
44 | };
45 |
46 | module.exports = {
47 | getDemoItemsService,
48 | createDemoItemService,
49 | getOneDemoItemService,
50 | deleteDemoItemService,
51 | updateOneDemoItemPropertyValueService,
52 | updateDemoItemPropertyValuesService,
53 | };
54 |
--------------------------------------------------------------------------------
/templates/cjs/src/app.js:
--------------------------------------------------------------------------------
1 | const express = require('express');
2 | const dotenv = require('dotenv');
3 | const morgan = require('morgan');
4 | const cors = require('cors');
5 | let appRouter = require('./api/routes/app.route');
6 | let demoRouter = require('./api/routes/demo.route');
7 |
8 | dotenv.config();
9 |
10 | const app = express();
11 |
12 | app.use(morgan('dev'));
13 | app.use(express.urlencoded({
14 | extended: false
15 | }));
16 | app.use(express.json());
17 | app.use(cors({ origin: [`http://localhost:${process.env.CLIENT_APP_PORT}`, `${process.env.CLIENT_APP_URL}`] }));
18 |
19 | //====== Use Routers =======
20 | app.use('/', appRouter);
21 | app.use('/demo', demoRouter);
22 | //==========================
23 |
24 | app.use(function (req, res, next) {
25 | const error = new Error('Route not found!');
26 | error.status = 404;
27 | next(error);
28 | });
29 |
30 | app.use(function (error, req, res) {
31 | res.status(error.status || 500);
32 | res.json({
33 | error: {
34 | message: error.message
35 | }
36 | });
37 | });
38 |
39 | module.exports = { app };
40 |
--------------------------------------------------------------------------------
/templates/cjs/src/db.atlas.connect.js:
--------------------------------------------------------------------------------
1 | const mongoose = require('mongoose');
2 | const dotenv = require('dotenv');
3 | const { afterAtlasDBconnectSuccessful, connectToDBunsuccessful } = require('../node-mongo-helpers');
4 |
5 | dotenv.config();
6 |
7 | const mongooseAtlasConnect = async function (port) {
8 | try {
9 | await mongoose.connect(`${process.env.MONGODB_ATLAS_URI}`);
10 | afterAtlasDBconnectSuccessful(port);
11 | } catch (err) {
12 | connectToDBunsuccessful(err);
13 | }
14 | }
15 |
16 | module.exports = mongooseAtlasConnect;
17 |
--------------------------------------------------------------------------------
/templates/cjs/src/server.atlas.js:
--------------------------------------------------------------------------------
1 | const mongooseAtlasConnect = require('./db.atlas.connect');
2 | const { app } = require('./app');
3 |
4 | const port = process.env.PORT_ATLAS || 3000;
5 |
6 | app.listen(port, function () {
7 | mongooseAtlasConnect(port);
8 | });
9 |
--------------------------------------------------------------------------------
/templates/esm/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | "@babel/preset-env"
4 | ]
5 | }
6 |
--------------------------------------------------------------------------------
/templates/esm/.editorconfig:
--------------------------------------------------------------------------------
1 | # Editor configuration, see https://editorconfig.org
2 | root = true
3 |
4 | [*]
5 | charset = utf-8
6 | indent_style = space
7 | end_of_line = lf
8 | indent_size = 2
9 | insert_final_newline = true
10 | trim_trailing_whitespace = true
11 |
12 | [*.js]
13 | quote_type = single
14 |
15 | [*.md]
16 | # max_line_length = off
17 | trim_trailing_whitespace = true
18 |
--------------------------------------------------------------------------------
/templates/esm/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "root": true,
3 | "parser": "@babel/eslint-parser",
4 | "extends": [
5 | "eslint:recommended",
6 | "plugin:import/warnings",
7 | "plugin:import/warnings"
8 | ],
9 | "parserOptions": {
10 | "ecmaVersion": 7,
11 | "requireConfigFile": false,
12 | "sourceType": "module"
13 | },
14 | "env": {
15 | "browser": true,
16 | "node": true
17 | },
18 | "rules": {
19 | "no-console": 1
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/templates/esm/README.md:
--------------------------------------------------------------------------------
1 | # @code-collabo's node-mongo API boilerplate template (es module)
2 |
3 | This project (@code-collabo/node-mongo-api-boilerplate-templates version 1.0.0) was generated with [@code-collabo/node-mongo-cli version 2.0.0](https://code-collabo.gitbook.io/node-mongo-v2.0.0).
4 |
5 | ## Connection option 1: Running the development server (mongoDB Atlas)
6 | #### Step 1
7 | Install dependencies:
8 | ````
9 | npm install
10 | ````
11 |
12 | #### Step 2
13 | - Ensure you have internet connection
14 | - Have a monogDB atlas cluster set up in the cloud
15 | - Get your atlas mongoDB uri string
16 |
17 | #### Step 3
18 | - Rename the `.env.example` file to `.env`
19 | - Change `PORT_ATLAS` environment variable to your preferred port number in the .env file
20 | - Add your atlas mongoDB uri string to the `MONGODB_ATLAS_URI` environment variable in the .env file
21 |
22 | #### Step 4
23 | Start the automated development server and choose ATLAS connection:
24 | ````
25 | npm run dev
26 | ````
27 |
28 | #### Step 4 (alternative)
29 | You can also use the (manual) development server alternative for connection to mongoDB atlas:
30 | ````
31 | npm run dev:atlas
32 | ````
33 |
34 | ## Connection option 2: Running the development server (mongoDB local)
35 | #### Step 1
36 | Install dependencies:
37 | ````
38 | npm install
39 | ````
40 |
41 | #### Step 2
42 | - Have mongoDB installed and running on your computer
43 | - Get your local mongoDB uri string
44 |
45 | #### Step 3
46 | - Rename the `.env.example` file to `.env`
47 | - Change `PORT_LOCAL` environment variable to your preferred port number in the .env file
48 | - Add your local mongoDB uri string to the `MONGODB_LOCAL_URI` environment variable in the .env file
49 |
50 | #### Step 4
51 | Start the automated development server and choose LOCAL connection:
52 | ````
53 | npm run dev
54 | ````
55 |
56 | #### Step 4 (alternative)
57 | You can also use the (manual) development server alternative for connection to local mongoDB:
58 | ````
59 | npm run dev:local
60 | ````
61 |
62 | ## Automated development server and commands
63 | - `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.
64 | - `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.
65 | - `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.
66 |
67 | ## Testing with the demo setup
68 | 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.
69 |
70 | ## API design
71 |
72 | |METHOD /endpoint|Description|Request body|
73 | |--|--|:--:|
74 | |GET /demo|Get all demo items in the database| No Request Body |
75 | |POST /demo|Create/add new demo item to the database|name, age|
76 | |GET /demo/:demoId|Get a demo item stored in the database by its ID|No Request Body|
77 | |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|
78 | |PUT /demo/:id|Update all properties of an existing demo item in the database, using the demo item's ID|name, age|
79 | |DELETE /demo/:demoId|Delete a demo item from the database, using the demo item's ID|No request body|
80 |
81 | ## API call requests and responses
82 |
83 | DELETE /demo/:demoId
241 |242 | Request body shape 243 |
244 |
245 | No request body 246 |247 |
248 | Successful response shape 249 |
250 |
251 | {
252 | "message": "string",
253 | "request": {
254 | "type": "string",
255 | "description": "string",
256 | "url": "string",
257 | "body": {
258 | "name": "string",
259 | "age": "string"
260 | }
261 | }
262 | }
263 |
264 |
84 |
86 | Request body shape 87 |
88 |
92 | Successful response shape 93 |
94 |
112 |
113 |
114 |
115 | GET /demo
85 |86 | Request body shape 87 |
88 |
89 | No request body 90 |91 |
92 | Successful response shape 93 |
94 |
95 | {
96 | "count": number,
97 | "items": [
98 | {
99 | "_id": "string",
100 | "name": "string",
101 | "age": number,
102 | "request": {
103 | "type": "string",
104 | "url": "string"
105 | }
106 | },
107 | // etc.
108 | ]
109 | }
110 |
111 |
116 |
118 | Request body shape 119 |
120 |
127 | Successful response shape 128 |
129 |
144 |
145 |
146 |
147 | POST /demo
117 |118 | Request body shape 119 |
120 |
121 | {
122 | "name": "string",
123 | "age": number
124 | }
125 |
126 | 127 | Successful response shape 128 |
129 |
130 | {
131 | "message": "string",
132 | "newItem": {
133 | "_id": "string",
134 | "name": "string",
135 | "age": number,
136 | "request": {
137 | "type": "string",
138 | "url": "string"
139 | }
140 | }
141 | }
142 |
143 |
148 |
150 | Request body shape 151 |
152 |
156 | Successful response shape 157 |
158 |
171 |
172 |
173 |
174 | GET /demo/:demoId
149 |150 | Request body shape 151 |
152 |
153 | No request body 154 |155 |
156 | Successful response shape 157 |
158 |
159 | {
160 | "_id": "string",
161 | "name": "string",
162 | "age": number,
163 | "request": {
164 | "type": "string",
165 | "description": "string",
166 | "url": "string"
167 | }
168 | }
169 |
170 |
175 |
177 | Request body shape 178 |
179 |
194 |
195 | Successful response shape 196 |
197 |
208 |
209 |
210 |
211 | PATCH /demo/:demoId
176 |177 | Request body shape 178 |
179 |
180 | [
181 | { "propName": "string", "value": "string" }
182 | ]
183 |
184 |
185 | OR
186 |
187 |
188 | [
189 | { "propName": "string", "value": number }
190 | ]
191 |
192 | i.e. propName can be string "name" or "age". Value is a string when name is the propName, while value is a number when age is the propName.
193 | 194 |
195 | Successful response shape 196 |
197 |
198 | {
199 | "message": "string",
200 | "request": {
201 | "type": "string",
202 | "description": "string",
203 | "url": "string"
204 | }
205 | }
206 |
207 |
212 |
214 | Request body shape 215 |
216 |
223 | Successful response shape 224 |
225 |
236 |
237 |
238 |
239 | PUT /demo/:id
213 |214 | Request body shape 215 |
216 |
217 | {
218 | "name": "string",
219 | "age": number
220 | }
221 |
222 | 223 | Successful response shape 224 |
225 |
226 | {
227 | "message": "string",
228 | "request": {
229 | "type": "string",
230 | "description": "string",
231 | "url": "string"
232 | }
233 | }
234 |
235 |
240 |
242 | Request body shape 243 |
244 |
248 | Successful response shape 249 |
250 |
265 |
266 | ## Documentation
267 | See the links to the official documentation of the node-mongo project and community building it below:
268 | - [Node Mongo documentation](https://code-collabo.gitbook.io/node-mongo-v2.0.0)
269 | - [Code Collabo documentation](https://code-collabo.gitbook.io/community-doc-v1.0.0)
270 |
--------------------------------------------------------------------------------
/templates/esm/node-mongo-helpers.js:
--------------------------------------------------------------------------------
1 | import { spawn } from 'child_process';
2 | import package_json from './package.json';
3 | import chalk from 'chalk';
4 |
5 | /* eslint-disable no-console */
6 |
7 | // console
8 | export const success = (message) => {
9 | console.log( chalk.greenBright(message) );
10 | }
11 |
12 | export const warning = (message) => {
13 | console.log( chalk.yellowBright(message) );
14 | }
15 |
16 | export const error = (message) => {
17 | console.log( chalk.redBright(message) );
18 | }
19 |
20 | // DB connect
21 | export const watchEslint = () => {
22 | const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
23 | spawn(npm, ['run', 'lint:watch'], { cwd: './', stdio: 'inherit' });
24 | }
25 |
26 | export const server = (serverPort) => {
27 | try {
28 | success(`\nnode-mongo (ES Module) API boilerplate template v${package_json.version}`);
29 | success(`\nServer running at ${serverPort}`);
30 | } catch (err) {
31 | error(`${{ err }}`);
32 | }
33 | }
34 |
35 | const eslintAndServer = (serverPort) => {
36 | watchEslint();
37 | server(serverPort);
38 | }
39 |
40 | export const afterAtlasDBconnectSuccessful = (serverPort) => {
41 | success('\nConnected to mongoDB ATLAS');
42 | eslintAndServer(serverPort);
43 | }
44 |
45 | export const afterLocalDBconnectSuccessful = (serverPort) => {
46 | success('\nConnected to LOCAL mongoDB');
47 | eslintAndServer(serverPort);
48 | }
49 |
50 | export const connectToDBunsuccessful = (err) => {
51 | error(`\nError in DB connection: ${err.message}\n`);
52 | warning('Refer to the node-mongo documentation: https://code-collabo.gitbook.io/node-mongo-v2.0.0\n\nGet further help from Code Collabo Community\'s Node mongo channel: https://matrix.to/#/#collabo-node-mongo:gitter.im\n');
53 | }
54 |
--------------------------------------------------------------------------------
/templates/esm/node-mongo.js:
--------------------------------------------------------------------------------
1 | import { chooseNodeMongoApiDBServer } from '@code-collabo/node-mongo-scripts/index';
2 |
3 | chooseNodeMongoApiDBServer();
4 |
5 |
--------------------------------------------------------------------------------
/templates/esm/node-mongo.json:
--------------------------------------------------------------------------------
1 | {
2 | "pathToCheck": "./src",
3 | "templateName": "esm"
4 | }
5 |
--------------------------------------------------------------------------------
/templates/esm/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "node-mongo-api-boilerplate-template-esm",
3 | "version": "1.0.0",
4 | "description": "@code-collabo node-mongo API boilerplate template - es module",
5 | "main": "src/server.[atlas/local].js",
6 | "scripts": {
7 | "dev": "node -r esm node-mongo.js",
8 | "dev:local": "nodemon --exec babel-node src/server.local.js",
9 | "dev:atlas": "nodemon --exec babel-node src/server.atlas.js",
10 | "lint": "esw src --color",
11 | "lint:watch": "npm run lint -- --watch",
12 | "dev:restore": "node -r esm node-mongo.js",
13 | "dev:change": "node -r esm node-mongo.js"
14 | },
15 | "author": "Author Name",
16 | "license": "ISC",
17 | "dependencies": {
18 | "@code-collabo/node-mongo-scripts": "^1.2.0",
19 | "cors": "^2.8.5",
20 | "dotenv": "^16.0.3",
21 | "esm": "^3.2.25",
22 | "express": "^4.18.2",
23 | "mongoose": "^7.0.5",
24 | "morgan": "^1.10.0"
25 | },
26 | "devDependencies": {
27 | "@babel/cli": "^7.21.0",
28 | "@babel/core": "^7.21.4",
29 | "@babel/eslint-parser": "^7.21.3",
30 | "@babel/node": "^7.20.7",
31 | "@babel/preset-env": "^7.21.4",
32 | "chalk": "^4.1.0",
33 | "eslint": "^8.39.0",
34 | "eslint-plugin-import": "^2.27.5",
35 | "eslint-watch": "^8.0.0",
36 | "nodemon": "^2.0.22"
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/templates/esm/src/api/controllers/app.controller.js:
--------------------------------------------------------------------------------
1 | import { success } from '../../../node-mongo-helpers';
2 |
3 | export const getAppController = async (req, res) => {
4 | const message = 'App works!';
5 | success(message);
6 | return res.status(200).json({ message });
7 | }
8 |
--------------------------------------------------------------------------------
/templates/esm/src/api/controllers/demo.controller.js:
--------------------------------------------------------------------------------
1 | import {
2 | getDemoItemsService,
3 | createDemoItemService,
4 | getOneDemoItemService,
5 | deleteDemoItemService,
6 | updateOneDemoItemPropertyValueService,
7 | updateDemoItemPropertyValuesService,
8 | } from '../services/demo.service';
9 | import { success, error } from '../../../node-mongo-helpers';
10 |
11 | const routeName = 'demo';
12 | const item = `${routeName}-item`;
13 |
14 | let response = {};
15 |
16 | const getDemoItemsController = async (req, res) => {
17 | try {
18 | const docs = await getDemoItemsService();
19 | response = {
20 | count: docs.length,
21 | items: docs.map((doc) => {
22 | return {
23 | _id: doc._id,
24 | name: doc.name,
25 | age: doc.age,
26 | request: {
27 | type: 'GET',
28 | url: `http://localhost:3000/${routeName}/${doc._id}`,
29 | },
30 | };
31 | }),
32 | };
33 | success(`GET request successful!`);
34 | return res.status(200).json(response);
35 | } catch (err) {
36 | error(`Error retriving ${item}s: ${err}`);
37 | res.status(500).json({
38 | error: `${err}`,
39 | });
40 | }
41 | };
42 |
43 | const createDemoItemController = async (req, res) => {
44 | try {
45 | const doc = await createDemoItemService(req.body);
46 | response = {
47 | message: `${item} created successfully!`,
48 | newItem: {
49 | _id: doc._id,
50 | name: doc.name,
51 | age: doc.age,
52 | request: {
53 | type: 'GET',
54 | url: `http://localhost:3000/${routeName}/${doc._id}`,
55 | },
56 | },
57 | }
58 | success(`${item} CREATED successfully!`);
59 | return res.status(201).json(response);
60 | } catch (err) {
61 | error(`Error saving ${item}: ${err}`);
62 | res.status(500).json({
63 | error: `${err}`,
64 | });
65 | }
66 | };
67 |
68 | const getOneDemoItemController = async (req, res) => {
69 | try {
70 | const doc = await getOneDemoItemService(req.params.demoId);
71 | if (doc) {
72 | response = {
73 | _id: doc._id,
74 | name: doc.name,
75 | age: doc.age,
76 | request: {
77 | type: 'GET',
78 | description: `Url link to all ${item}s`,
79 | url: `http://localhost:3000/${routeName}/`,
80 | },
81 | }
82 | success(`GET request successful!`);
83 | return res.status(200).json(response);
84 | } else {
85 | error('No record found for provided ID');
86 | return res.status(404).json({
87 | message: 'No record found for provided ID',
88 | });
89 | }
90 | } catch (err) {
91 | error(`Error retriving ${item}: ${err}`);
92 | res.status(500).json({
93 | message: 'Invalid ID',
94 | error: `${err}`,
95 | });
96 | }
97 | };
98 |
99 | const deleteDemoItemController = async (req, res) => {
100 | try {
101 | await deleteDemoItemService(req.params.demoId);
102 | response = {
103 | message: `${item} deleted successfully!`,
104 | request: {
105 | type: 'POST',
106 | description: 'Url link to make post request to',
107 | url: `http://localhost:3000/${item}/`,
108 | body: {
109 | name: 'String',
110 | age: 'Number',
111 | },
112 | },
113 | }
114 | success(`${item} DELETED successfully!`);
115 | return res.status(200).json(response);
116 | } catch (err) {
117 | error(`Error deleting ${item}: ${err}`);
118 | res.status(500).json({
119 | message: `Error deleting ${item}`,
120 | error: `${err}`,
121 | });
122 | }
123 | };
124 |
125 | const updateOneDemoItemPropertyValueController = async (req, res) => {
126 | try {
127 | const id = req.params.demoId;
128 | await updateOneDemoItemPropertyValueService(id, req.body);
129 | response = {
130 | message: 'Patch request successful!',
131 | request: {
132 | type: 'GET',
133 | description: `Url link to updated ${item}`,
134 | url: `http://localhost:3000/${routeName}/${id}`,
135 | },
136 | };
137 | success(`PATCH request for ID ${id} successful!`);
138 | return res.status(200).json(response);
139 | } catch (err) {
140 | error(`Error updating ${item} property & value: ${err}`);
141 | res.status(500).json({
142 | message: `Error updating ${item} property & value`,
143 | error: `${err}`,
144 | });
145 | }
146 | };
147 |
148 | const updateDemoItemPropertyValuesController = async (req, res) => {
149 | try {
150 | const id = req.params.id;
151 | await updateDemoItemPropertyValuesService(id, req.body);
152 | response = {
153 | message: `Put request successful!`,
154 | request: {
155 | type: 'GET',
156 | description: `Url link to updated ${item}`,
157 | url: `http://localhost:3000/${routeName}/${id}`,
158 | },
159 | };
160 | success(`PUT request for ID ${id} successful!`);
161 | return res.status(200).json(response);
162 | } catch (err) {
163 | error(`Error updating ${item}: ${err}`);
164 | res.status(500).json({
165 | message: `Error updating ${item}`,
166 | error: `${err}`,
167 | });
168 | }
169 | };
170 |
171 | export {
172 | getDemoItemsController,
173 | createDemoItemController,
174 | getOneDemoItemController,
175 | deleteDemoItemController,
176 | updateOneDemoItemPropertyValueController,
177 | updateDemoItemPropertyValuesController,
178 | };
179 |
--------------------------------------------------------------------------------
/templates/esm/src/api/models/demo.model.js:
--------------------------------------------------------------------------------
1 | import mongoose from 'mongoose';
2 |
3 | const collectionName = 'demo';
4 |
5 | const DemoSchema = mongoose.Schema({
6 | name: { type: String, required: true },
7 | age: { type: Number, required: true }
8 | });
9 |
10 | const DemoModel = mongoose.model(collectionName, DemoSchema, collectionName); //declare collection name a second time to prevent mongoose from pluralizing or adding 's' to the collection name
11 |
12 | export { DemoModel };
13 |
--------------------------------------------------------------------------------
/templates/esm/src/api/routes/app.route.js:
--------------------------------------------------------------------------------
1 | import express from 'express';
2 | import { getAppController } from '../controllers/app.controller';
3 |
4 | const router = express.Router();
5 |
6 | router.get('/', getAppController);
7 |
8 | export { router };
9 |
--------------------------------------------------------------------------------
/templates/esm/src/api/routes/demo.route.js:
--------------------------------------------------------------------------------
1 | import express from 'express';
2 | import {
3 | getDemoItemsController,
4 | createDemoItemController,
5 | getOneDemoItemController,
6 | deleteDemoItemController,
7 | updateOneDemoItemPropertyValueController,
8 | updateDemoItemPropertyValuesController,
9 | } from '../controllers/demo.controller';
10 |
11 | const router = express.Router();
12 |
13 | router.get('/', getDemoItemsController);
14 | router.post('/', createDemoItemController);
15 | router.get('/:demoId', getOneDemoItemController);
16 | router.delete('/:demoId', deleteDemoItemController);
17 | router.patch('/:demoId', updateOneDemoItemPropertyValueController);
18 | router.put('/:id', updateDemoItemPropertyValuesController);
19 |
20 | export { router };
21 |
--------------------------------------------------------------------------------
/templates/esm/src/api/services/demo.service.js:
--------------------------------------------------------------------------------
1 | import { DemoModel as Demo } from '../models/demo.model';
2 |
3 | export const getDemoItemsService = async () => {
4 | const query = await Demo.find().select('_id name age').exec();
5 | return query;
6 | };
7 |
8 | export const createDemoItemService = async (requestBody) => {
9 | const demo = new Demo({
10 | name: requestBody.name,
11 | age: requestBody.age,
12 | });
13 | const save = await demo.save();
14 | return save;
15 | };
16 |
17 | export const getOneDemoItemService = async (paramsId) => {
18 | const query = Demo.findById(paramsId).select('_id name age').exec();
19 | return query;
20 | };
21 |
22 | export const deleteDemoItemService = async (paramsId) => {
23 | const query = await Demo.deleteOne({ _id: paramsId }).exec();
24 | return query;
25 | };
26 |
27 | export const updateOneDemoItemPropertyValueService = async (paramsId, requestBody) => {
28 | const updateOps = {};
29 | for (const ops of requestBody) {
30 | updateOps[ops.propName] = ops.value;
31 | }
32 | const query = await Demo.updateOne({ _id: paramsId }, { $set: updateOps }).exec();
33 | return query;
34 | };
35 |
36 | export const updateDemoItemPropertyValuesService = async (paramsId, requestBody) => {
37 | const resetItem = {
38 | name: requestBody.name,
39 | age: requestBody.age,
40 | };
41 | const query = await Demo.findByIdAndUpdate(paramsId, { $set: resetItem }, { new: true }).exec();
42 | return query;
43 | };
44 |
--------------------------------------------------------------------------------
/templates/esm/src/app.js:
--------------------------------------------------------------------------------
1 | import express from 'express';
2 | import dotenv from 'dotenv';
3 | import morgan from 'morgan';
4 | import cors from 'cors';
5 | import { router as appRouter } from './api/routes/app.route';
6 | import { router as demoRouter } from './api/routes/demo.route';
7 |
8 | dotenv.config();
9 |
10 | const app = express();
11 |
12 | app.use(morgan('dev'));
13 | app.use(express.urlencoded({
14 | extended: false
15 | }));
16 | app.use(express.json());
17 | app.use(cors({ origin: [`http://localhost:${process.env.CLIENT_APP_PORT}`, `${process.env.CLIENT_APP_URL}`] }));
18 |
19 | //====== Use Routers =======
20 | app.use('/', appRouter);
21 | app.use('/demo', demoRouter);
22 | //==========================
23 |
24 | app.use((req, res, next) => {
25 | const error = new Error('Route not found!');
26 | error.status = 404;
27 | next(error);
28 | });
29 |
30 | app.use((error, req, res) => {
31 | res.status(error.status || 500);
32 | res.json({
33 | error: {
34 | message: error.message
35 | }
36 | });
37 | });
38 |
39 | export { app };
40 |
--------------------------------------------------------------------------------
/templates/esm/src/db.atlas.connect.js:
--------------------------------------------------------------------------------
1 | import mongoose from 'mongoose';
2 | import dotenv from 'dotenv';
3 | import { afterAtlasDBconnectSuccessful, connectToDBunsuccessful } from '../node-mongo-helpers';
4 |
5 | dotenv.config();
6 |
7 | const mongooseAtlasConnect = async (port) => {
8 | try {
9 | await mongoose.connect(`${process.env.MONGODB_ATLAS_URI}`);
10 | afterAtlasDBconnectSuccessful(port);
11 | } catch (err) {
12 | connectToDBunsuccessful(err);
13 | }
14 | }
15 |
16 | export default mongooseAtlasConnect;
17 |
--------------------------------------------------------------------------------
/templates/esm/src/server.atlas.js:
--------------------------------------------------------------------------------
1 | import mongooseAtlasConnect from './db.atlas.connect';
2 | import { app as app } from './app';
3 |
4 | const port = process.env.PORT_ATLAS || 3000;
5 |
6 | app.listen(port, () => {
7 | mongooseAtlasConnect(port);
8 | });
9 |
--------------------------------------------------------------------------------
/templates/ts/.editorconfig:
--------------------------------------------------------------------------------
1 | # Editor configuration, see https://editorconfig.org
2 | root = true
3 |
4 | [*]
5 | charset = utf-8
6 | indent_style = space
7 | end_of_line = lf
8 | indent_size = 2
9 | insert_final_newline = true
10 | trim_trailing_whitespace = true
11 |
12 | [*.ts]
13 | quote_type = single
14 |
15 | [*.md]
16 | # max_line_length = off
17 | trim_trailing_whitespace = true
18 |
--------------------------------------------------------------------------------
/templates/ts/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "root": true,
3 | "parser": "@typescript-eslint/parser",
4 | "extends": [
5 | "eslint:recommended",
6 | "plugin:@typescript-eslint/recommended"
7 | ],
8 | "parserOptions": {
9 | "ecmaVersion": 12,
10 | "sourceType": "module"
11 | },
12 | "plugins": [
13 | "@typescript-eslint"
14 | ],
15 | "env": {
16 | "browser": true,
17 | "es2021": true
18 | },
19 | "rules": {
20 | "no-console": 1,
21 | "@typescript-eslint/no-unused-vars": "error",
22 | "@typescript-eslint/consistent-type-definitions": ["error"] // you can also add "type" in the array
23 | }
24 | }
--------------------------------------------------------------------------------
/templates/ts/README.md:
--------------------------------------------------------------------------------
1 | # @code-collabo's node-mongo API boilerplate template (typescript)
2 |
3 | This project (@code-collabo/node-mongo-api-boilerplate-templates version 1.0.0) was generated with [@code-collabo/node-mongo-cli version 2.0.0](https://code-collabo.gitbook.io/node-mongo-v2.0.0).
4 |
5 | ## Connection option 1: Running the development server (mongoDB Atlas)
6 | #### Step 1
7 | Install dependencies:
8 | ````
9 | npm install
10 | ````
11 |
12 | #### Step 2
13 | - Ensure you have internet connection
14 | - Have a monogDB atlas cluster set up in the cloud
15 | - Get your atlas mongoDB uri string
16 |
17 | #### Step 3
18 | - Rename the `.env.example` file to `.env`
19 | - Change `PORT_ATLAS` environment variable to your preferred port number in the .env file
20 | - Add your atlas mongoDB uri string to the `MONGODB_ATLAS_URI` environment variable in the .env file
21 |
22 | #### Step 4
23 | Start the automated development server and choose ATLAS connection:
24 | ````
25 | npm run dev
26 | ````
27 |
28 | #### Step 4 (alternative)
29 | You can also use the (manual) development server alternative for connection to mongoDB atlas:
30 | ````
31 | npm run dev:atlas
32 | ````
33 |
34 | ## Connection option 2: Running the development server (mongoDB local)
35 | #### Step 1
36 | Install dependencies:
37 | ````
38 | npm install
39 | ````
40 |
41 | #### Step 2
42 | - Have mongoDB installed and running on your computer
43 | - Get your local mongoDB uri string
44 |
45 | #### Step 3
46 | - Rename the `.env.example` file to `.env`
47 | - Change `PORT_LOCAL` environment variable to your preferred port number in the .env file
48 | - Add your local mongoDB uri string to the `MONGODB_LOCAL_URI` environment variable in the .env file
49 |
50 | #### Step 4
51 | Start the automated development server and choose LOCAL connection:
52 | ````
53 | npm run dev
54 | ````
55 |
56 | #### Step 4 (alternative)
57 | You can also use the (manual) development server alternative for connection to local mongoDB:
58 | ````
59 | npm run dev:local
60 | ````
61 |
62 | ## Automated development server and commands
63 | - `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.
64 | - `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.
65 | - `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.
66 |
67 | ## Testing with the demo setup
68 | 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.
69 |
70 | ## API design
71 |
72 | |METHOD /endpoint|Description|Request body|
73 | |--|--|:--:|
74 | |GET /demo|Get all demo items in the database| No Request Body |
75 | |POST /demo|Create/add new demo item to the database|name, age|
76 | |GET /demo/:demoId|Get a demo item stored in the database by its ID|No Request Body|
77 | |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|
78 | |PUT /demo/:id|Update all properties of an existing demo item in the database, using the demo item's ID|name, age|
79 | |DELETE /demo/:demoId|Delete a demo item from the database, using the demo item's ID|No request body|
80 |
81 | ## API call requests and responses
82 |
83 | DELETE /demo/:demoId
241 |242 | Request body shape 243 |
244 |
245 | No request body 246 |247 |
248 | Successful response shape 249 |
250 |
251 | {
252 | "message": "string",
253 | "request": {
254 | "type": "string",
255 | "description": "string",
256 | "url": "string",
257 | "body": {
258 | "name": "string",
259 | "age": "string"
260 | }
261 | }
262 | }
263 |
264 |
84 |
86 | Request body shape 87 |
88 |
92 | Successful response shape 93 |
94 |
112 |
113 |
114 |
115 | GET /demo
85 |86 | Request body shape 87 |
88 |
89 | No request body 90 |91 |
92 | Successful response shape 93 |
94 |
95 | {
96 | "count": number,
97 | "items": [
98 | {
99 | "_id": "string",
100 | "name": "string",
101 | "age": number,
102 | "request": {
103 | "type": "string",
104 | "url": "string"
105 | }
106 | },
107 | // etc.
108 | ]
109 | }
110 |
111 |
116 |
118 | Request body shape 119 |
120 |
127 | Successful response shape 128 |
129 |
144 |
145 |
146 |
147 | POST /demo
117 |118 | Request body shape 119 |
120 |
121 | {
122 | "name": "string",
123 | "age": number
124 | }
125 |
126 | 127 | Successful response shape 128 |
129 |
130 | {
131 | "message": "string",
132 | "newItem": {
133 | "_id": "string",
134 | "name": "string",
135 | "age": number,
136 | "request": {
137 | "type": "string",
138 | "url": "string"
139 | }
140 | }
141 | }
142 |
143 |
148 |
150 | Request body shape 151 |
152 |
156 | Successful response shape 157 |
158 |
171 |
172 |
173 |
174 | GET /demo/:demoId
149 |150 | Request body shape 151 |
152 |
153 | No request body 154 |155 |
156 | Successful response shape 157 |
158 |
159 | {
160 | "_id": "string",
161 | "name": "string",
162 | "age": number,
163 | "request": {
164 | "type": "string",
165 | "description": "string",
166 | "url": "string"
167 | }
168 | }
169 |
170 |
175 |
177 | Request body shape 178 |
179 |
194 |
195 | Successful response shape 196 |
197 |
208 |
209 |
210 |
211 | PATCH /demo/:demoId
176 |177 | Request body shape 178 |
179 |
180 | [
181 | { "propName": "string", "value": "string" }
182 | ]
183 |
184 |
185 | OR
186 |
187 |
188 | [
189 | { "propName": "string", "value": number }
190 | ]
191 |
192 | i.e. propName can be string "name" or "age". Value is a string when name is the propName, while value is a number when age is the propName.
193 | 194 |
195 | Successful response shape 196 |
197 |
198 | {
199 | "message": "string",
200 | "request": {
201 | "type": "string",
202 | "description": "string",
203 | "url": "string"
204 | }
205 | }
206 |
207 |
212 |
214 | Request body shape 215 |
216 |
223 | Successful response shape 224 |
225 |
236 |
237 |
238 |
239 | PUT /demo/:id
213 |214 | Request body shape 215 |
216 |
217 | {
218 | "name": "string",
219 | "age": number
220 | }
221 |
222 | 223 | Successful response shape 224 |
225 |
226 | {
227 | "message": "string",
228 | "request": {
229 | "type": "string",
230 | "description": "string",
231 | "url": "string"
232 | }
233 | }
234 |
235 |
240 |
242 | Request body shape 243 |
244 |
248 | Successful response shape 249 |
250 |
265 |
266 | ## Documentation
267 | See the links to the official documentation of the node-mongo project and community building it below:
268 | - [Node Mongo documentation](https://code-collabo.gitbook.io/node-mongo-v2.0.0)
269 | - [Code Collabo documentation](https://code-collabo.gitbook.io/community-doc-v1.0.0)
270 |
--------------------------------------------------------------------------------
/templates/ts/node-mongo-helpers.ts:
--------------------------------------------------------------------------------
1 | import { spawn } from 'child_process';
2 | import package_json from './package.json';
3 | import chalk from 'chalk';
4 |
5 | /* eslint-disable no-console */
6 |
7 | // console
8 | export const success = (message: string) => {
9 | console.log( chalk.greenBright(message) );
10 | }
11 |
12 | export const warning = (message: string) => {
13 | console.log( chalk.yellowBright(message) );
14 | }
15 |
16 | export const error = (message: string) => {
17 | console.log( chalk.redBright(message) );
18 | }
19 |
20 | // DB connect
21 | export const npmRunPackageJsonScript = ({ script, currentWorkingDir } : { script: string, currentWorkingDir: string }): void => {
22 | const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
23 | spawn(npm, ['run', script], { cwd: currentWorkingDir, stdio: 'inherit' });
24 | }
25 |
26 | export const server = (serverPort: number | string): void => {
27 | try {
28 | success(`\nnode-mongo (Typescript) API boilerplate template v${package_json.version}`);
29 | success(`\nServer running at ${serverPort}`);
30 | } catch (err) {
31 | error(`${{ err }}`);
32 | }
33 | }
34 |
35 | const eslintAndServer = (serverPort: number | string) => {
36 | npmRunPackageJsonScript({ script: 'lint:watch', currentWorkingDir: './' });
37 | server(serverPort);
38 | }
39 |
40 | export const afterAtlasDBconnectSuccessful = (serverPort: number | string) => {
41 | success('\nConnected to mongoDB ATLAS');
42 | eslintAndServer(serverPort);
43 | }
44 |
45 | export const afterLocalDBconnectSuccessful = (serverPort: number | string) => {
46 | success('\nConnected to LOCAL mongoDB');
47 | eslintAndServer(serverPort);
48 | }
49 |
50 | export const connectToDBunsuccessful = (err: { message: unknown; }) => {
51 | error(`\nError in DB connection: ${err.message}\n`);
52 | warning('Refer to the node-mongo documentation: https://code-collabo.gitbook.io/node-mongo-v2.0.0\n\nGet further help from Code Collabo Community\'s Node mongo channel: https://matrix.to/#/#collabo-node-mongo:gitter.im\n');
53 | }
54 |
--------------------------------------------------------------------------------
/templates/ts/node-mongo.js:
--------------------------------------------------------------------------------
1 | import { chooseNodeMongoApiDBServer } from '@code-collabo/node-mongo-scripts/index';
2 |
3 | chooseNodeMongoApiDBServer();
4 |
5 |
--------------------------------------------------------------------------------
/templates/ts/node-mongo.json:
--------------------------------------------------------------------------------
1 | {
2 | "pathToCheck": "./src",
3 | "templateName": "ts"
4 | }
5 |
--------------------------------------------------------------------------------
/templates/ts/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "node-mongo-api-boilerplate-template-ts",
3 | "version": "1.0.0",
4 | "description": "@code-collabo node-mongo API boilerplate template - typescript",
5 | "main": "src/server.[atlas/local].ts",
6 | "scripts": {
7 | "dev": "node -r esm node-mongo.js",
8 | "dev:local": "nodemon --exec ts-node src/server.local.ts",
9 | "dev:atlas": "nodemon --exec ts-node src/server.atlas.ts",
10 | "lint": "esw src --ext .ts --color",
11 | "lint:watch": "npm run lint -- --watch",
12 | "dev:restore": "node -r esm node-mongo.js",
13 | "dev:change": "node -r esm node-mongo.js"
14 | },
15 | "author": "Author Name",
16 | "license": "ISC",
17 | "dependencies": {
18 | "@code-collabo/node-mongo-scripts": "^1.2.0",
19 | "cors": "^2.8.5",
20 | "dotenv": "^16.0.3",
21 | "esm": "^3.2.25",
22 | "express": "^4.18.2",
23 | "mongoose": "^7.0.5",
24 | "morgan": "^1.10.0"
25 | },
26 | "devDependencies": {
27 | "@types/body-parser": "^1.19.2",
28 | "@types/cors": "^2.8.13",
29 | "@types/express": "^4.17.17",
30 | "@types/morgan": "^1.9.4",
31 | "@types/node": "^18.16.1",
32 | "@typescript-eslint/eslint-plugin": "^5.59.1",
33 | "@typescript-eslint/parser": "^5.59.1",
34 | "chalk": "^4.1.0",
35 | "eslint": "^8.39.0",
36 | "eslint-watch": "^8.0.0",
37 | "nodemon": "^2.0.22",
38 | "ts-node": "^10.9.1",
39 | "typescript": "^5.0.4"
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/templates/ts/src/api/controllers/app.controller.ts:
--------------------------------------------------------------------------------
1 | import { Request, Response } from 'express';
2 | import { success } from '../../../node-mongo-helpers';
3 |
4 | export const getAppController = async (req: Request, res: Response) => {
5 | const message = 'App works!';
6 | success(message);
7 | return res.status(200).json({ message });
8 | }
9 |
--------------------------------------------------------------------------------
/templates/ts/src/api/controllers/demo.controller.ts:
--------------------------------------------------------------------------------
1 | import { Request, Response } from 'express';
2 | import {
3 | getDemoItemsService,
4 | createDemoItemService,
5 | getOneDemoItemService,
6 | deleteDemoItemService,
7 | updateOneDemoItemPropertyValueService,
8 | updateDemoItemPropertyValuesService,
9 | } from '../services/demo.service';
10 | import { success, error } from '../../../node-mongo-helpers';
11 |
12 | const routeName = 'demo';
13 | const item = `${routeName}-item`;
14 |
15 | let response: { [key: string]: unknown } = {};
16 |
17 | export const getDemoItemsController = async (req: Request, res: Response) => {
18 | try {
19 | const docs = await getDemoItemsService();
20 | response = {
21 | count: docs.length,
22 | items: docs.map(doc => {
23 | return {
24 | _id: doc._id,
25 | name: doc.name,
26 | age: doc.age,
27 | request: {
28 | type: 'GET',
29 | url: `http://localhost:3000/${routeName}/${doc._id}`
30 | }
31 | }
32 | })
33 | };
34 | success(`GET request successful!`);
35 | return res.status(200).json(response);
36 | } catch (err) {
37 | error(`Error retriving ${item}s: ${err}`);
38 | res.status(500).json({
39 | error: `${err}`
40 | });
41 | }
42 | }
43 |
44 | export const createDemoItemController = async (req: Request, res: Response) => {
45 | try {
46 | const doc = await createDemoItemService(req.body);
47 | response = {
48 | message: `${item} created successfully!`,
49 | newItem: {
50 | _id: doc._id,
51 | name: doc.name,
52 | age: doc.age,
53 | request: {
54 | type: 'GET',
55 | url: `http://localhost:3000/${routeName}/${doc._id}`,
56 | },
57 | },
58 | }
59 | success(`${item} CREATED successfully!`);
60 | return res.status(201).json(response);
61 | } catch (err) {
62 | error(`Error saving ${item}: ${err}`);
63 | res.status(500).json({
64 | error: `${err}`,
65 | });
66 | }
67 | }
68 |
69 | export const getOneDemoItemController = async (req: Request, res: Response) => {
70 | try {
71 | const doc = await getOneDemoItemService(req.params.demoId);
72 | if (doc) {
73 | response = {
74 | _id: doc._id,
75 | name: doc.name,
76 | age: doc.age,
77 | request: {
78 | type: 'GET',
79 | description: `Url link to all ${item}s`,
80 | url: `http://localhost:3000/${routeName}/`,
81 | },
82 | }
83 | success(`GET request successful!`);
84 | return res.status(200).json(response);
85 | } else {
86 | error('No record found for provided ID');
87 | return res.status(404).json({
88 | message: 'No record found for provided ID',
89 | });
90 | }
91 | } catch (err) {
92 | error(`Error retriving ${item}: ${err}`);
93 | res.status(500).json({
94 | message: 'Invalid ID',
95 | error: `${err}`,
96 | });
97 | }
98 | }
99 |
100 | export const deleteDemoItemController = async (req: Request, res: Response) => {
101 | try {
102 | await deleteDemoItemService(req.params.demoId);
103 | response = {
104 | message: `${item} deleted successfully!`,
105 | request: {
106 | type: 'POST',
107 | description: 'Url link to make post request to',
108 | url: `http://localhost:3000/${item}/`,
109 | body: {
110 | name: 'String',
111 | age: 'Number',
112 | },
113 | },
114 | }
115 | success(`${item} DELETED successfully!`);
116 | return res.status(200).json(response);
117 | } catch (err) {
118 | error(`Error deleting ${item}: ${err}`);
119 | res.status(500).json({
120 | message: `Error deleting ${item}`,
121 | error: `${err}`,
122 | });
123 | }
124 | };
125 |
126 | export const updateOneDemoItemPropertyValueController = async (req: Request, res: Response) => {
127 | try {
128 | const id: string = req.params.demoId;
129 | await updateOneDemoItemPropertyValueService(id, req.body);
130 | response = {
131 | message: 'Patch request successful!',
132 | request: {
133 | type: 'GET',
134 | description: `Url link to updated ${item}`,
135 | url: `http://localhost:3000/${routeName}/${id}`,
136 | },
137 | };
138 | success(`PATCH request for ID ${id} successful!`);
139 | return res.status(200).json(response);
140 | } catch (err) {
141 | error(`Error updating ${item} property & value: ${err}`);
142 | res.status(500).json({
143 | message: `Error updating ${item} property & value`,
144 | error: `${err}`,
145 | });
146 | }
147 | };
148 |
149 | export const updateDemoItemPropertyValuesController = async (req: Request, res: Response) => {
150 | try {
151 | const id: string = req.params.id;
152 | await updateDemoItemPropertyValuesService(id, req.body);
153 | response = {
154 | message: `Put request successful!`,
155 | request: {
156 | type: 'GET',
157 | description: `Url link to updated ${item}`,
158 | url: `http://localhost:3000/${routeName}/${id}`,
159 | },
160 | };
161 | success(`PUT request for ID ${id} successful!`);
162 | return res.status(200).json(response);
163 | } catch (err) {
164 | error(`Error updating ${item}: ${err}`);
165 | res.status(500).json({
166 | message: `Error updating ${item}`,
167 | error: `${err}`,
168 | });
169 | }
170 | };
171 |
--------------------------------------------------------------------------------
/templates/ts/src/api/models/demo.model.ts:
--------------------------------------------------------------------------------
1 | import mongoose from 'mongoose';
2 |
3 | export interface DemoDocument extends mongoose.Document {
4 | name: string;
5 | age: number;
6 | }
7 |
8 | const collectionName = 'demo';
9 |
10 | const DemoSchema = new mongoose.Schema({
11 | name: { type: String, required: true },
12 | age: { type: Number, required: true }
13 | });
14 |
15 | const DemoModel = mongoose.modelDELETE /demo/:demoId
241 |242 | Request body shape 243 |
244 |
245 | No request body 246 |247 |
248 | Successful response shape 249 |
250 |
251 | {
252 | "message": "string",
253 | "request": {
254 | "type": "string",
255 | "description": "string",
256 | "url": "string",
257 | "body": {
258 | "name": "string",
259 | "age": "string"
260 | }
261 | }
262 | }
263 |
264 |