Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updated #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 51 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,51 @@
# Referraly by Eulercoder


Free and open source Referral System.:
# 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)