neosoft-technologies / rest-node-nestjs Goto Github PK

Unit Testing the caching strategies used.

This API performs the basic CRUD functionalities by directly communicating with the database in the back-end of the application

CI/CD is a method to frequently deliver apps to customers by introducing automation into the stages of app development.
Using CI & CD for deploying the build to SIT, UAT and Prod environments.

• #168
• #169
• #170

API documentation: with swagger-jsdoc and swagger-ui-express

Originally posted by @shishirYadav in #17
Swagger is an Interface Description Language for describing RESTful APIs expressed using JSON.

Always write unit test case for every api

Originally posted by @arya0618 in #18

To check whether the given api is properly calling the required methods or not or proper service of the api is being executed or not.

NoSQL database: MongoDB object data modeling using Mongoose

• Create Basic Connection with Mongoose
• Defining Mongoose Model
• CRUD Operations

Discussed in #15

Documenting the implementation of caching module.

Common handler for cache which can only be used in response handler.

Its should be configure with cron-job operation

Originally posted by @shantanuneosoft in #31

Discussed in #27

Compress HTTP response using GZIP Compression

Identifying the correct storage options for assets and media files like s3 or cloud storage is very important aspect of any project architecture. In addition to this deciding on caching strategies also plays key role in project performance in long run

Originally posted by @adnankhan-neo in #52

• #159
• #160
• #161
• #163

Document the changes

Compression: gzip compression with compression

Originally posted by @shishirYadav in #13

Compression can greatly decrease the size of the response body, thereby increasing the speed of a web app.
Using compression and decompression we can send HTTPS requests and responses easily.

• #156
• #157
• #158

Discussed in #51

Idea is to have sample code for various type of payment integration and redme about each payment integration. Like if we have sample code for razorPay integration then we should also have readme for it about how to use it and in which cases it could be useful. Along with it additional information about in which countries this payment integration would work for.

the folder structure to be like src/paymentIntegration/razorPay

Originally posted by @suresh-shetiar in #28

• #214
• #215
• #216
• #217

Always add one dummy API to check server is up or not

Originally posted by @arya0618 in #92

• #164
• #165

Discussed in #38

Discussed in #25

Discussed in #7

API rate limiting as an added security feature. As DoS attacks can tank a server with unlimited API requests.

Originally posted by @suresh-shetiar in #54

• #210
• #211
• #212
• #213
• #227

Basic Socket.io - Websocket integration

Originally posted by @PareshNeosoft in #114
A WebSocket is a persistent connection between a client and server. With this API, you can send messages to a server and receive event-driven responses without having to poll the server for a reply.

Document the implementational details of encryption-decryption module

For every module, there could be many npm to be used/ module that can be used as per usage/ different integrations.

for the folder structure, just an idea about creating folder structure under src as the 'src/purpose of module/integrationName'

for example: payment:
'src/payment/razorPay'
for example email:
'src/email/sendgrid'

Originally posted by @suresh-shetiar in #30

• T - Folder Structure
• T - Folder Documentations and Naming Conventions

We have multiple platforms available which allows us to send an email. The idea is to have a sample code for email sender with multiple types of integration.
Email sender with NodeMailer, Sendgrid, AWS SES, and others which are famous and available as per the need

• #171
• #172
• #173
• #279

Unit test cases for compression

To maintain sensitive data like db/app configuration we can use parameter store.
Instead of .env file we can store all sensitive information/configurations on AWS parameter store and fetch as per requirement, this will avoid unwanted data modification on the developer end.

Originally posted by @Riyazm16 in #60

The application requires generating a report in word/pdf format from an HTML template.

Originally posted by @PareshNeosoft in #115

• Structure for documentation
• Update landing page
• Create different sections
• Review [@sasachan]

Unit test cases for encryption-decryption module

We should have an encryption and decryption model, such that we can encrypt and decrypt important data.

Originally posted by @mdmudassiriqbal in #42

Various inbuilt hashing algorithms are available such as AES(Advanced Encryption System)can be used for encryption which is available through the crypto module in NodeJS. This will be important for saving the user details in an encrypted format.

• #109
• #110
• #116
• #117
• #118

Login flow, pkce and implicit flow, social login

Originally posted by @suresh-shetiar in #27
Passport is a popular node JS authentication library which can be used

Integrating the encryption-decryption module with request handler. This will encrypt the request coming from the user and then we have to decrypt it in the back-end.

• #178
• #179
• #180

Discussed in #22

Discussed in #32

• #288
• #291
• #292
• #166
• #167
• #282
• #287

Integrating the encryption-decryption module with request and response handler. Encrypting the response from the server and then decrypting in the front-end.

Showcase the following items as part of bi-weekly sync

• Setup Discord showcase channel @sasachan
• Setup Meetup date/time, description and related item @sasachan
• #181
• Quick presentation @santoshshinde2012
• Showcase discussion tab @santoshshinde2012
• Project and milestone @santoshshinde2012
• Application code @santoshshinde2012
• Test project @santoshshinde2012
• CI Pipeline @santoshshinde2012
• #182

• #145
• #146
• #147
• #148

• #174
• #175
• #176
• #177

Discussed in #40

For every module, there could be many npm to be used/ module that can be used as per usage/ different integrations.

for the folder structure, just an idea about creating folder structure under src as the 'src/purpose of module/integrationName'

for example: payment:
'src/payment/razorPay'
for example email:
'src/email/sendgrid'