AndrewJBateman / node-koa-data

:clipboard: Node.js used with Koa instead of Express middleware, with embedded javascript (EJS) & Bootstrap to display oil well data

⚡ Node Koa Data

• Node.js used with Koa instead of Express middleware, with embedded javascript (EJS) & Bootstrap to display oil well data
• Note: to open web links in a new window use: ctrl+click on link

📄 Table of contents

• ⚡ Node Koa Data
  • 📄 Table of contents
  • 📚 General info
  • 📷 Screenshots
  • 📶 Technologies
  • 💾 Setup
  • 🔧 Testing
  • 💻 Code Examples
  • 🆒 Features
  • 📋 Status, Testing & To-Do List
  • 👏 Inspiration
  • 📁 License
  • ✉️ Contact

📚 General info

• Koa middleware used to add routing, body-parser, JSON and EJS HTML views
• Simple Bootstrap navbar
• An oil well name can be added to the list - this is not stored in a database and will be lost when app is shut down.

📷 Screenshots

📶 Technologies

• Node.js v16 Javascript runtime using the Chrome V8 engine
• koa v2 HTTP middleware alternative to Express.js
• koa-ejs v4 embedded Javascript
• Bootstrap v5 responsive navbar and styling

💾 Setup

• npm i to install dependencies
• npm run dev runs app in the development mode with auto-restart.
• Open http://localhost:5000 to view in the browser.

🔧 Testing

• N/A

💻 Code Examples

• index.js asynchronous function to render the index page in the browser root using Koa middleware

router.get("/", async (ctx) => {
  await ctx.render("index", {
    title: "Underground Injection Control Wells",
    wells: wells,
  });
});

🆒 Features

• Uses Koa which is much lighter than the usual Express middleware

📋 Status, Testing & To-Do List

• Status: Working
• To-Do: Add well update and delete + database connection & other db fields such as location of well etc.

👏 Inspiration

• Oklahoma Oil Well Data
• esparkinfo.com/blog: Express vs Koa: Which Node.js Framework Is Best For You?

📁 License

• This project is licensed under the terms of the MIT license.

✉️ Contact

• Repo created by ABateman, email: [e-mail]