feature: Introduce backend seeds and documentation improvements

.gitignore

@@ -128,6 +128,6 @@ tmtags
 *.sql
 *.sqlite
 *.db
-/backend/node-express/hello-world/package-lock.json
-/backend/node-express/hello-world/yarn.lock
-/backend/node-express/hello-world/package-lock.json
+/backend/node-express-js/node-express-starter-js/package-lock.json
+/backend/node-express-js/node-express-starter-js/yarn.lock
+/backend/node-express-js/node-express-starter-js/package-lock.json

README.md

@@ -17,9 +17,10 @@ implementing your logic.
 
 ## Technologies & Frameworks Supported
 
-- **Web Frameworks**: React, Vue.js, Angular, etc.
-- **Backend Frameworks**: Express, Django, Flask, etc.
-- **Databases**: MongoDB, PostgreSQL, MySQL, Elasticsearch, etc.
+- **Frontend Frameworks**: React, Vue.js, Angular, etc.
+- **Backend Frameworks**: Node.js, Django, Flask, etc.
+- **Data Processing**: Pandas, Apache Spark, Hadoop, Kubernetes Jobs, etc.
+- **Artificial Intelligence & Machine Learning**: TensorFlow, PyTorch, SciKit-Learn, Keras, etc.
 - ... and many more!
 
 ## How to Use a Seed
@@ -38,9 +39,10 @@ we'd love for you to contribute. Check out our [Contributing Guide](./CONTRIBUTI
 
 When creating a PR, make sure to attach appropriate labels. This helps in categorizing and reviewing PRs efficiently:
 
-- `web-framework`: For seeds related to web frameworks.
+- `frontend`: For seeds related to frontend frameworks.
 - `backend`: For backend-specific seeds.
-- `database`: For seeds with a specific database focus.
+- `data-processing`: For seeds focused on data processing techniques and tools.
+- `ml/ai`: For seeds related to artificial intelligence and machine learning technologies.
 - ... (you can extend this list based on the categories of seeds you anticipate)
 
 ## What Makes a Good Seed?

backend/node-express/README.md → backend/node-express-js/README.md

@@ -1,12 +1,14 @@
-# Node-Express Seeds
+# Node-Express Seeds  (JavaScript Version)
 
 This repository contains multiple seeds (starter templates) for Node.js projects using Express.js with different
 configurations and additions.
 
 ## Folder Structure
 
-- **hello-world**: This contains a basic Node-Express seed to get you started with a simple "Hello, World!" API.
-- **mongoose**: This seed incorporates Mongoose, enabling you to quickly start a project with MongoDB integration.
+- **node-express-starter-js**: This contains a basic Node-Express seed to get you started with a simple "Hello, World!"
+  API.
+- **node-express-mongoose-js**: This seed incorporates Mongoose, enabling you to quickly start a project with MongoDB
+  integration.
 
 ## Getting Started
 

backend/node-express-js/node-express-mongoose-js/README.md

@@ -0,0 +1,36 @@
+# Node Express - Mongoose with Javascript Seed
+
+This seed helps you kickstart your Node.js projects using Express.js and **Javascript** with integrated MongoDB support
+through Mongoose.
+
+## Getting Started
+
+- Navigate to the `mongoose` directory.
+- Configure environment variables as described in the [local development](#local-development) section.
+- Ensure you have a MongoDB instance running or use your connection string in the `.env` for an external database.
+- Run `yarn install` to install the necessary dependencies.
+- Use `yarn start` to start the server.
+- Your API is now connected to a MongoDB instance, and you can begin creating models, routes, etc.
+
+## Dependencies
+
+This seed uses:
+
+- [Express.js](https://expressjs.com/): A fast, minimalist web framework for Node.js.
+- [Mongoose](https://mongoosejs.com/): Elegant MongoDB object modeling for Node.js.
+
+## Local Development
+
+This seed uses environment variables for configuration:
+
+- Make sure to set up your `.env` file by using `.env.example` as a reference.
+- Adjust the values in `.env` as necessary to match your setup.
+
+## Warestack Deployments
+
+For this Flask API to be compatible with automated deployments on Warestack, the inclusion of the `healthz` endpoint is
+mandatory. Warestack uses this endpoint to ensure that the service is running correctly.
+
+## Questions & Contributions
+
+If you have any questions or wish to contribute, please open an issue or submit a pull request.

backend/node-express/mongoose/app/app.js → backend/node-express-js/node-express-mongoose-js/app/app.js

@@ -3,8 +3,10 @@ const express = require('express');
 // Load environment variables from .env file
 require('dotenv').config();
 
-const dbConfig = require('./config/database')
+const dbConfig = require('./config/database');
 
+const RootController = require('./root/root.controller');
+const HealthController = require('./health/health.controller');
 const UsersController = require('./user/user.controller');
 
 class App {
@@ -27,6 +29,8 @@ class App {
         dbConfig.connect();
     }
     routes() {
+        this.app.use('/', new RootController().getRouter());
+        this.app.use('/healthz', new HealthController().getRouter());
         this.app.use(`/users`, new UsersController().getRouter());
     }
 }

backend/node-express-js/node-express-mongoose-js/app/health/health.controller.js

@@ -0,0 +1,23 @@
+const express = require('express');
+
+const HealthService = require('./health.service');
+
+class HealthController {
+    constructor() {
+        this.router = express.Router();
+
+        // Setting the routes for the greeting endpoint group
+        this.router.get('/', this.health().bind(this)); // Binding is necessary for 'this' to refer to the class instance
+    }
+
+    getRouter() {
+        return this.router;
+    }
+
+    async health(request, response, next) {
+        const message = HealthService.health();
+        response.status(200).send(message);
+    }
+}
+
+module.exports = HealthController;

backend/node-express-js/node-express-mongoose-js/app/health/health.service.js

@@ -0,0 +1,7 @@
+class HealthService {
+    health() {
+        return "I am healthy!";
+    }
+}
+
+module.exports = new HealthService();  // Exporting an instance of the service

backend/node-express-js/node-express-mongoose-js/app/root/root.controller.js

@@ -0,0 +1,22 @@
+const express = require('express');
+const RootService = require('./root.service');
+
+class RootController {
+    constructor() {
+        this.router = express.Router();
+
+        // Setting the routes for the root endpoint group
+        this.router.get('/', this.info.bind(this)); // Binding is necessary for 'this' to refer to the class instance
+    }
+
+    getRouter() {
+        return this.router;
+    }
+
+    async info(request, response, next) {
+        const message = RootService.info();
+        response.status(200).send(message);
+    }
+}
+
+module.exports = RootController;

backend/node-express-js/node-express-mongoose-js/app/root/root.service.js

@@ -0,0 +1,7 @@
+class RootService {
+    info() {
+        return "Hello, World!";
+    }
+}
+
+module.exports = new RootService();  // Exporting an instance of the service

backend/node-express-js/node-express-mongoose-js/app/user/user.controller.js

@@ -0,0 +1,76 @@
+const express = require('express');
+const UserService = require('../services/users.service');
+
+class UsersController {
+    constructor() {
+        this.router = express.Router();
+        this.router.get('/', this.getUsers.bind(this));
+        this.router.get('/:email', this.getUserByEmail.bind(this));
+        this.router.post('/', this.createUser.bind(this));
+        this.router.put('/:email', this.updateUser.bind(this));
+        this.router.delete('/:email', this.deleteUser.bind(this));
+    }
+
+    getRouter() {
+        return this.router;
+    }
+
+    async getUsers(request, response, next) {
+        try {
+            const users = await UserService.getUsers();
+            response.status(200).send(users);
+        } catch (e) {
+            next(e);
+        }
+    }
+
+    async getUserByEmail(request, response, next) {
+        try {
+            const user = await UserService.getUserByEmail(request.params.email);
+            if (!user) {
+                response.status(404).send({ message: 'User not found.' });
+                return;
+            }
+            response.status(200).send(user);
+        } catch (e) {
+            next(e);
+        }
+    }
+
+    async createUser(request, response, next) {
+        try {
+            const user = await UserService.createUser(request.body);
+            response.status(201).send(user);
+        } catch (e) {
+            next(e);
+        }
+    }
+
+    async updateUser(request, response, next) {
+        try {
+            const updatedUser = await UserService.updateUser(request.params.email, request.body);
+            if (!updatedUser) {
+                response.status(404).send({ message: 'User not found.' });
+                return;
+            }
+            response.status(200).send(updatedUser);
+        } catch (e) {
+            next(e);
+        }
+    }
+
+    async deleteUser(request, response, next) {
+        try {
+            const deletedUser = await UserService.deleteUser(request.params.email);
+            if (!deletedUser) {
+                response.status(404).send({ message: 'User not found.' });
+                return;
+            }
+            response.status(200).send(deletedUser);
+        } catch (e) {
+            next(e);
+        }
+    }
+}
+
+module.exports = UsersController;

backend/node-express-js/node-express-mongoose-js/app/user/user.model.js

@@ -0,0 +1,15 @@
+const mongoose = require('mongoose');
+
+const userSchema = new mongoose.Schema({
+    name: {
+        type: String,
+        required: true
+    },
+    email: {
+        type: String,
+        required: true,
+        unique: true
+    }
+});
+
+module.exports = mongoose.model('User', userSchema);

backend/node-express-js/node-express-mongoose-js/app/user/user.service.js

@@ -0,0 +1,45 @@
+const User = require('../models/user');
+
+class UserService {
+    async getUsers() {
+        try {
+            return await User.find();
+        } catch (err) {
+            throw new Error('Error fetching users from the database.');
+        }
+    }
+
+    async getUserByEmail(email) {
+        try {
+            return await User.findOne({ email: email });
+        } catch (err) {
+            throw new Error('Error fetching user by email.');
+        }
+    }
+
+    async createUser(user) {
+        try {
+            return await User.create(user);
+        } catch (err) {
+            throw new Error('Error creating user.');
+        }
+    }
+
+    async updateUser(email, user) {
+        try {
+            return await User.findOneAndUpdate({ email: email }, user, { new: true });
+        } catch (err) {
+            throw new Error('Error updating user.');
+        }
+    }
+
+    async deleteUser(email) {
+        try {
+            return await User.findOneAndDelete({ email: email });
+        } catch (err) {
+            throw new Error('Error deleting user.');
+        }
+    }
+}
+
+module.exports = new UserService();  // Exporting an instance of the service

backend/node-express/mongoose/package.json → backend/node-express-js/node-express-mongoose-js/package.json

@@ -1,7 +1,7 @@
 {
-  "name": "node-express-base-seed",
+  "name": "node-express-mongoose-js",
   "version": "1.0.0",
-  "description": "A foundational seed for Node-Express projects.",
+  "description": "A foundational seed for Node-Express and Javascript with Mongoose projects.",
   "main": "server.js",
   "scripts": {
     "start": "node server.js"

backend/node-express-js/node-express-starter-js/.env.example

@@ -0,0 +1 @@
+PORT=3000

backend/node-express-js/node-express-starter-js/README.md

@@ -0,0 +1,36 @@
+# Hello World - Node Express with Javascript Seed
+
+This seed is a basic starter for building an Express.js API with **JavaScript** that simply responds with "Hello,
+World!".
+
+## Getting Started
+
+- Navigate to the `node-express-starter-js` directory.
+- Configure environment variables as described in the [local development](#local-development) section.
+- Run `yarn install` to install the necessary dependencies.
+- Use `yarn start` to start the server.
+- Access the API at `http://localhost:3000`. You should receive a "Hello, World!" message.
+- The `healthz` endpoint at http://localhost:3000/healthz provides a health check response which is crucial for
+    Warestack's deployment automation.
+
+## Dependencies
+
+This seed uses:
+
+- [Express.js](https://expressjs.com/): A fast, minimalist web framework for Node.js.
+
+## Local Development
+
+This seed uses environment variables for configuration:
+
+- Make sure to set up your `.env` file by using `.env.example` as a reference.
+- Adjust the values in `.env` as necessary to match your setup.
+
+## Warestack Deployments
+
+For this Flask API to be compatible with automated deployments on Warestack, the inclusion of the `healthz` endpoint is
+mandatory. Warestack uses this endpoint to ensure that the service is running correctly.
+
+## Questions & Contributions
+
+If you have any questions or wish to contribute, please open an issue or submit a pull request.

backend/node-express/hello-world/app/app.js → backend/node-express-js/node-express-starter-js/app/app.js

@@ -1,6 +1,7 @@
 const express = require('express');
 
-const GreetingController = require('./greeting/greeting.controller');
+const RootController = require('./root/root.controller');
+const HealthController = require('./health/health.controller');
 
 class App {
     constructor() {
@@ -12,7 +13,8 @@ class App {
     }
 
     routes() {
-        this.app.use('/greeting', new GreetingController().getRouter());
+        this.app.use('/', new RootController().getRouter());
+        this.app.use('/healthz', new HealthController().getRouter());
     }
 }