https://github.com/andrewjbateman/node-koa-data

:clipboard: Node.js used with Koa instead of Express middleware, with embedded javascript (EJS) & Bootstrap to display oil well data
https://github.com/andrewjbateman/node-koa-data

bootstrap bootstrap5 ejs-templates javascript koa koa-bodyparser koa-json koa-router nodejs

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/andrewjbateman/node-koa-data
• Owner: AndrewJBateman
• Created: 2022-04-27T08:57:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-14T17:57:28.000Z (about 2 years ago)
• Last Synced: 2024-11-07T03:33:21.500Z (about 2 months ago)
• Topics: bootstrap, bootstrap5, ejs-templates, javascript, koa, koa-bodyparser, koa-json, koa-router, nodejs
• Language: HTML
• Homepage:
• Size: 168 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# :zap: 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_

![GitHub repo size](https://img.shields.io/github/repo-size/AndrewJBateman/node-koa-data?style=plastic)

![GitHub pull requests](https://img.shields.io/github/issues-pr/AndrewJBateman/node-koa-data?style=plastic)

![GitHub Repo stars](https://img.shields.io/github/stars/AndrewJBateman/node-koa-data?style=plastic)

![GitHub last commit](https://img.shields.io/github/last-commit/AndrewJBateman/node-koa-data?style=plastic)

## :page_facing_up: Table of contents

* [:zap: Node Koa Data](#zap-node-koa-data)

  * [:page_facing_up: Table of contents](#page_facing_up-table-of-contents)

  * [:books: General info](#books-general-info)

  * [:camera: Screenshots](#camera-screenshots)

  * [:signal_strength: Technologies](#signal_strength-technologies)

  * [:floppy_disk: Setup](#floppy_disk-setup)

  * [:wrench: Testing](#wrench-testing)

  * [:computer: Code Examples](#computer-code-examples)

  * [:cool: Features](#cool-features)

  * [:clipboard: Status, Testing & To-Do List](#clipboard-status-testing--to-do-list)

  * [:clap: Inspiration](#clap-inspiration)

  * [:file_folder: License](#file_folder-license)

  * [:envelope: Contact](#envelope-contact)

## :books: 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.

## :camera: Screenshots

![Image](./img/list.png)

## :signal_strength: Technologies

* [Node.js v16](https://nodejs.org/) Javascript runtime using the [Chrome V8 engine](https://v8.dev/)

* [koa v2](https://www.npmjs.com/package/koa) HTTP middleware alternative to Express.js

* [koa-ejs v4](https://www.npmjs.com/package/koa-ejs) embedded Javascript

* [Bootstrap v5](https://getbootstrap.com) responsive navbar and styling

## :floppy_disk: Setup

* `npm i` to install dependencies

* `npm run dev` runs app in the development mode with auto-restart.

* Open [http://localhost:5000](http://localhost:5000) to view in the browser.

## :wrench: Testing

* N/A

## :computer: Code Examples

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

```javascript

router.get("/", async (ctx) => {

  await ctx.render("index", {

    title: "Underground Injection Control Wells",

    wells: wells,

  });

});

```

## :cool: Features

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

## :clipboard: 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.

## :clap: Inspiration

* [Oklahoma Oil Well Data](https://oklahoma.gov/occ/divisions/oil-gas/oil-gas-data.html)

* [esparkinfo.com/blog: Express vs Koa: Which Node.js Framework Is Best For You?](https://www.esparkinfo.com/blog/express-vs-koa.html)

## :file_folder: License

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

## :envelope: Contact

* Repo created by [ABateman](https://github.com/AndrewJBateman), email: [email protected]