From a28c9399571a78b81997c1ce362df1b5159360ad Mon Sep 17 00:00:00 2001 From: Bikram Bhattacharya Date: Thu, 12 Oct 2017 00:03:14 +0530 Subject: [PATCH] Readme updated --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/README.md b/README.md index e69de29..965b2f3 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,51 @@ +# Random Code Generator + +Random Code Generator — as the name suggests it will be generate random numbers. Now you must be thinking just random generators? really? There are hundreds of code snippets already available which can generate random numbers. + + +So, this is more than just Random Code Generator. Here are different type of codes that our system will be able to generate. + +- Serial Numbers (N9TT — 9G0A — B7FQ — RANC) +- Strong Passwords ( )8V)CC3[k6Hj ) +- Pronounceable Codes (azazer) +- Giftcard/Voucher Codes (744-NRY-264) +- Suffixed Codes (LRA-MEQ-A) +- Country prefixed codes (US-GXZSYU) +- Length ‘X’— Letters and Digits (gYtpe4NB) +- Pattern — XX99??AA (XX9901AA) + +# Why? What’s the use? 🤔 + +There are lots of usage of this. You just need to spend some time, think the places where such random codes are used. Your Credit or Debit cards? Promotional codes maybe? In resetting a password Or Sending Unique Links for signups? + +Many companies spend a lot of time in writing such codes and then creating a system which can validate the codes and verify it has been used before or not. + +- We are going to create a system which will generate such random codes and then keep them in our database. + +- We will have our API for generating random codes based on the cases and total codes required. + +- There will be API for validating whether the code has been used before or not. + +- Using our APIs, companies can generate thousands of random numbers and send them to their users once they get hacked 🙈 🙉. + +- Using our APIs, companies can send unique sign up links, promotion code, vouchers to their users/customers. + +- We will take care of everything for them from generation to validation. + +# Installation + +- clone the repo +- cd codegenerate +- npm install +- npm start + +# Getting Started +[Please read this article on Random Code Generator](https://medium.com/eulercoder/eulercoder-project-series-project-statement-2-random-code-generator-and-codechecker-3a7a2d5607cd) + +# Issues + +Check [Issue tracker](https://github.com/Eulercoder/codegenerate/issues) for all the issues. + +# License + +[MIT](https://github.com/eulercoder/fabulous/blob/master/LICENSE) Licence (c) [Vikesh Tiwari](https://github.com/vicky002)