PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

This is a simple API in the boilerplate that executes CRUD for the api which contains the actions that interact with services and exposes the endpoints

1. Implement a todo api the follows our api standards

• GEt /todos
• POST /todos
• GET /todos/:todoid

Expected Behavour if Issue is Bug?

Steps to Reproduce if Issue is a Bug?

Add healthRoute to starter

Acceptance criteria

• Add healtheRoute to health check the service. It can be as simple us it return 200 on a get request
• Add test to healthRoute

Issue Summary

Many files still make reference to yarn even though it's not used.
They must be changed to use npm instead

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

Packages listed in package.json should be changed to latest versions instead of using exact versions.
The .npmrc file will then ensure that any new project will install exact versions of listed packages.
The goal here is to have new projects use up-to-date versions of packages

Add dredd testing to match api documentation to it implementation

Acceptance Criteria

• Add aglio to parse api docs and also to generate a nice interface for our docs
• Add dredd testing to ci pipeline on codeship.

Logger currently uses bunyan for logging. It Provides common functionality like

• logging request ,
• exposes parent bunyan logger,
• patches req for each router to have req.log

Add test to test the above functionality for logger

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

This contain the checks to see if the application is behaving properly

Add integration tests based on requirements in todo

This issue is a sub task of #8

Add dredd testing to docs

Add unit tests for the todo app based on docs.

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

this will be for:

• Adding a new api
• Adding a new process type

Expected Behavour if Issue is Bug?

Add Expected Behaviour here

Actual Behaviour if Issue is a Bug?

Add Actual Behavour here

Steps to Reproduce if Issue is a Bug?

1. This is the first step
2. This is the second step

Other Technical details if Needed ?

Test this in ubuntu only

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

once i push my code check doesn't pass because the project express api starter codeshipcheck fails.

Expected Behavour if Issue is Bug?

Steps to Reproduce if Issue is a Bug?

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

wrapper for client

Expected Behavour if Issue is Bug?

Add Expected Behaviour here

Actual Behaviour if Issue is a Bug?

Add Actual Behavour here

Steps to Reproduce if Issue is a Bug?

1. This is the first step
2. This is the second step

Other Technical details if Needed ?

Test this in ubuntu only

Crete a sample todo API app as defined in the docs.

Acceptance Criteria

• Add integration test to the api. (100% coverage)
• Add unit testing (100% coverage)
• Add implementation to todo as described in docs.
• Add Dredd testing to todo docs #9
• Add Client interface to your api. Basically this is what other services will call when they want to interact with your service
• Add test to client interface (100% coverage)

Notes

Tools - supertest mocha chai(expect) sinon-chai sinon
Also we encourage functional programming 😄

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

This documents the API to fit the api description format of open API 3.0

At kudobuzzz we have a bunch of services working together to make sure our goals are achieved. To make it easy for use to kick start new services we need to have a boilerplate that should contain our best practices, updated tools and so on.
Main Goals
Writing an application that is easy to scale and maintain.
The config is well separated from the business logic.
Our application can consist of multiple process types.

Acceptance Criteria

• - it should take advantage of some of things we have learnt over the years which we consider really good
• - it should use https://github.com/kudobuzz/kbscripts to provide a zero config boilerplate.
• - it should have some example code, a todo example might be cool
• - it should consider best practices from here https://github.com/i0natan/nodebestpractices
• - it should test example code using our testing strategies https://medium.com/javascript-scene/mocking-is-a-code-smell-944a70c90a6a
• - add health checks
• - Add logger https://github.com/kudobuzz/logger
• - it should follow https://12factor.net/
• - it should follow our api standards https://github.com/kudobuzz/api-standards
• - Add issue and pr templates

Notes

There are quite a number of things that might not be here but this issue should be more of a
discussion

Tasks

• - Create folder structure and add documentation for each folders #25
• - Add pr and issue templates
• - Implement lint, test and precommit, prepush according to docs

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

• Document Api
• Document api in openapi 3.0.0

This will focus on folder structures only.

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

This explain the tests for API which contains all scripts that interact with the services ,workers

Expected Behavour if Issue is Bug?

Add Expected Behaviour here

Actual Behaviour if Issue is a Bug?

Add Actual Behavour here

Steps to Reproduce if Issue is a Bug?

1. This is the first step
2. This is the second step

Other Technical details if Needed ?

Test this in ubuntu only

PreSubmission Checklist

• The necessary labels have added
• I have assigned issues to the right project

Issue Summary

This documents layout and structure of the project. and how the flow of the project should be

Acceptance Criteria

• Complete layout of project structure
• Clearly explains each segment in project Structure

Issue Summary

We want to improve express-api-starter to contain all the information needed for new developers to quickly pick up how things are done here.

Acceptance Criteria

• Document project structure
• Document how we handle test for api, workers or any concerns
• Document api in openapi 3.0.0
• Include a client wrapper
• - Project Setup
  -[ ] - Implement a todo api the follows our api standards
  - GEt /todos
  - POST /todos
  - GET /todos/:todoid
• Include health route
• Start resources properly using resource manager #
• Add autogeneration for basic things like
  - Adding a new api
  - Adding a new processtype

Task

• Document project structure #30
• Document how we handle test for api, workers or any concerns #31
• Document api in openapi 3.0.0 #32
• Include a client wrapper #36
• - Project Setup #33
• Include health route #34