Skip to content

Commit

Permalink
README.md updated
Browse files Browse the repository at this point in the history
  • Loading branch information
hassanzhd committed May 2, 2020
1 parent a9ced48 commit 768641d
Showing 1 changed file with 32 additions and 25 deletions.
57 changes: 32 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,38 @@
# The Year Book

A simple year book web app.

## Technology Stack:

###1. DESIGN PATTERN (MVC)
1. ### DESIGN PATTERN (MVC)

- **Model:**
NO-SQL MONGO-DB was used with MONGOOSE ODM
- **View:**
Handlebars-js templating engine was used with native HTML and CSS
- **Controller:**
All controller and server-side logic was wriiten in JavaScript (Node-js alongside Express-js)

###2. AUTHENTICATION:
"Passport-js" using local strategy

###3. SESSION MANAGEMENT:
"express-session" integrated with "passport-js"

###4. IMAGE STORAGE:
Images are stored inside database in base-64 format and uploaded using "multer"

###5. PASSWORD HASHING:
Password hashing is done using "bcrypt"

###6. EMAIL VERIFICATION:
Email verification is done using "nodemailer" and "OAuth2" protocol (google cloud api). Verification hash is generated using "crypto"

###7. APP AND DATABASE HOSTING:
1. App: Heroku
2. Database: Mongodb Atlas
NO-SQL MONGO-DB was used with MONGOOSE ODM
- **View:**
Handlebars-js templating engine was used with native HTML and CSS
- **Controller:**
All controller and server-side logic was wriiten in JavaScript (Node-js alongside Express-js)

2. ### AUTHENTICATION:

"Passport-js" using local strategy

3. ### SESSION MANAGEMENT:

"express-session" integrated with "passport-js"

4. ### IMAGE STORAGE:

Images are stored inside database in base-64 format and uploaded using "multer"

5. ### PASSWORD HASHING:

Password hashing is done using "bcrypt"

6. ### EMAIL VERIFICATION:

Email verification is done using "nodemailer" and "OAuth2" protocol (google cloud api). Verification hash is generated using "crypto"

7. ### APP AND DATABASE HOSTING:
1. App: Heroku
2. Database: Mongodb Atlas

0 comments on commit 768641d

Please sign in to comment.