Giter Club home page Giter Club logo

birthday-api's Introduction

birthday-api

An API using Node and Express for storing data of, and sending birthday greetings. The aim of this was to focus on displaying maintainability, re-usability, and testability of a simple API.

Coupling has been minimised and Modularity has been maximised by trying to use the single-responsibility principle and dependency injection wherever possible.

Please note that there has been no focus on security, auth, or data reliability as this is a simple proof of concept.

General overview

I have tried to split up responsibility into three key areas:

/providers are used to interact with data stores and external services. In this case a local data store and email.

/services handle logic for their specific service, separate from routing, databases, etc.

/validators handle validation of input data

Install dependencies

npm i

Node version used: 15.1.0

NPM version used: 7.0.8

Test

npm run test

Test results

Mocked tests using Jest and SuperTest can be found in /tests

Dev

npm run dev

A Postman Collection has been provided for convenience

Email

The email provider has been very hastily put together, using an un-secure auth method that is being removed by gmail in May 2022. But worked to prove the concept.

birthday-api's People

Contributors

throwingspoon avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.