officialyenum/yenum-api

Yenum Api

Yenum api implementation built with Node, Express Typescript and MongoDb

Table of Contents

• Technologies
• Getting Started
  • Installation
  • Usage
  • Testing
  • Documentation
  • Deployment
  • Limitations

Technologies

• NodeJS - Runtime Environment
• Express - A Fast, unopinionated, minimalist web framework for Node.js
• MongoDb - A document database used to build highly available and scalable internet applications.
• Mongoose - A Node. js-based Object Data Modeling (ODM) library for MongoDB
• Npm - Dependency Manager

Getting Started

Installation

• git clone Yenum Api
• Run npm install to install packages.
• Docker or a local mongodb installation is required.
• There is docker-compose.yml file for starting Docker, run docker-compose up to start the container.
• Copy .env.example file, create a .env file if not created and edit database credentials there.
• Run npm run start to run the application in production.-
• Run npm run dev to run the application in development mode.

Usage

This is the basic flow of the application.

Games

• View all Games.
• can create a Game.
• can update a Game.
• can delete a Game.

Prayers

• Get The Daily Rosary Prayer Linked with Mystery for current day (in development)
• Get The Holy Rosary Mysteries (in development)
• Get The Catholic Prayers (in development)

Testing

• Run npm run test to run the unit tests
• Run npm run test:e2e to run the end to end tests (A '.env.testing' file is included in the project to connect to the in memory mongo server for tests).

Documentation

• Please click here to access the Postman Collection

Deployment

This project is hosted on heroku

• Please click here to access the hosted application

Limitations

• Caching is not implemented
• Pagination is not implemented
• Testing is not implemented