Light

codetanzania / majifix-service Goto Github PK

View Code? Open in Web Editor NEW

2.0 3.0 0.0 3.24 MB

A representation of an acceptable service (request types)(e.g Water Leakage) offered(or handled) by a specific jurisdiction

License: MIT License

JavaScript 100.00%

codetanzania majifix majfix-module open311 service citizen feedback

majifix-service's Introduction

majifix-service

A representation of an acceptable service (request types)(e.g Water Leakage) offered(or handled) by a specific jurisdiction.

Requirements

Installation

npm install @codetanzania/majifix-service --save

Usage

import { connect } from '@lykmapipo/mongoose-common';
import { Service, start } from '@codetanzania/majifix-service-group';

// connect to mongodb
connect(process.env.MONGODB_URI, error => { ... });

// fire http server
start(error => { ... });

Testing

Clone this repository
Install all development dependencies

npm install

Run example

npm run dev

Then run test

npm test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

References

Open311 GeoReport v2

Licence

The MIT License (MIT)

Copyright (c) CodeTanzania & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

majifix-service's People

Contributors

Stargazers

Watchers

majifix-service's Issues

Review for release of version 1.0.0

Module Release Checklist

NOTE: Make sure all tests are running before committing your changes

Update Dependencies

Update faker dev dependency to use @benmaruchu/faker
Update all majifix modules used to latest version of @codetanzania/majifix-{module-name}
Update other dependencies
Fix Http router specs to use api version in URL from app router
Remove body parser in dev dependency

Project Structure

Make sure .npmignore exist and it ignores right files i.e examples, docs
Make sure .editorconfig exist

Files to crosscheck

README.md

Use standard formatting
Update Requirements for node to match engines in package.json
Update installation instructions
Update Usage to use new package name i.e @codetanzania/majifix-{module-name}
Fix any typos
Update Node engine minimum version
Update Mongoose version

CHANGELOG.md

Add release version and date in the format v1.0.0 / yyyy-mm-dd
add list of changes/features in the release

package.json

Update package name in package.json to use @CodeTanzania scope
Update package version number

Update keywords in package.json to be

 	  "keywords": [
 		"codetanzania",
 		"majifix",
 		"majifix-module",
 		  "<replace with module-name>",
 		  "open311"
   ],

Update sandbox url to use new api version

Add engines as

     "engines": {
 	   "node": ">=8.11.1",
 	   "npm": ">=5.6.0"
 	}

.model.js

if there is model file

jsdoc

Crosscheck authors are there
Make sure the version number is updated

For block comments with separators use hyphens to show separations

  /*
  *---------------------------------------------------------------------
  * Statics
  *---------------------------------------------------------------------
  */

Make sure the formatting for jsdoc follow it's conventions
Fix any typos

codes

Make sure spacing between blocks in 2 lines
Make sure the code organization is right
For local constants should be under local constant comment

.router.js

if there is router file

Fix any typos
Update api version
Make sure all routes are well documented
Generate API documents

.app.json

if there is app.json file

Make sure the details are correct
Make sure keywords resembles those from package.json

.apidoc.json

if there is apidoc.json

Remove description field
Remove version field
Update sample url and url to use latest API url format

Generate API Documentation

if applicable to the module

Run a command
```
grunt doc
```
Generate apidoc and crosscheck if everything is ok

Github

Update topic to improve repo searching in github

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

chore(deps): update dependency cz-conventional-changelog to v3.3.0

Detected dependencies

npm

package.json

@codetanzania/majifix-common >=0.17.0

@codetanzania/majifix-jurisdiction >=1.8.0

@codetanzania/majifix-priority >=1.6.0

@codetanzania/majifix-service-group >=1.4.0

@lykmapipo/common 0.43.4

@lykmapipo/env >=0.12.2

@lykmapipo/express-common >=0.17.10

@lykmapipo/express-rest-actions >=0.6.7

@lykmapipo/mongoose-common >=0.25.11

@lykmapipo/mongoose-exportable >=0.3.7

@lykmapipo/predefine >=0.8.0

async >=3.1.0

express >=4.17.1

lodash >=4.17.15

moment >=2.24.0

mongoose-locale-schema >=0.4.0

mongoose-rest-actions >=0.28.8

@babel/cli 7.14.5

@babel/core 7.14.6

@babel/node 7.14.5

@babel/preset-env 7.14.5

@babel/register 7.14.5

@benmaruchu/faker 4.3.0

@commitlint/cli 11.0.0

@commitlint/config-conventional 11.0.0

@commitlint/travis-cli 11.0.0

@lykmapipo/express-test-helpers 0.9.16

@lykmapipo/mongoose-test-helpers 0.7.19

chai 4.3.4

commitizen 4.2.4

coveralls 3.1.0

cz-conventional-changelog 3.2.1

doxdox 3.0.0

eslint 6.8.0

eslint-config-airbnb-base 14.2.1

eslint-config-prettier 7.2.0

eslint-plugin-import 2.23.4

eslint-plugin-jsdoc 24.0.6

eslint-plugin-mocha 6.3.0

eslint-plugin-prettier 3.4.0

generate-changelog 1.8.0

handlebars 4.7.7

husky 4.3.8

lint-staged 10.5.4

lodash.template 4.5.0

mocha 8.4.0

mongoose 5.12.13

npm-check-updates 4.1.2

nyc 15.1.0

prettier 2.3.1

rimraf 3.0.2

rollup 2.51.2

shelljs 0.8.4

mongoose >=5.6.11 || 5.12.4 || 5.12

node >=12.4.0

npm >=6.9.0

travis

.travis.yml

Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.