Skip to content

Commit 0fa68e7

Browse files
Updated Readme (sayedazharsabri#12)
* Updated Readme files for Quiz App and it's backend folder * Changed static badges to simple links. * Changed alignment in connect
1 parent bc43970 commit 0fa68e7

6 files changed

+45
-8
lines changed

README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
1-
# Quiz-App
2-
This is a Quiz App
1+
![!\[Alt text\](<Quiz_App (3).png>)](<backend/doc/images/Quiz_App (3).png>)
32

4-
# What you can learn by exploring
3+
![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/sayedazharsabri/Quiz-App-REST-API-TS-Mongoose)
4+
![GitHub issues](https://img.shields.io/github/issues/sayedazharsabri/Quiz-App-REST-API-TS-Mongoose)
5+
![GitHub contributors](https://img.shields.io/github/contributors/sayedazharsabri/Quiz-App-REST-API-TS-Mongoose)
6+
![GitHub forks](https://img.shields.io/github/forks/sayedazharsabri/Quiz-App-REST-API-TS-Mongoose)
57

6-
# How to start?
8+
Welcome to the QuizApp project! This interactive and engaging quiz application, introduces user with various key concepts on both Frontend and Backend.
9+
10+
- [Backend](backend/README.md)
11+
- [Frontend](frontend/README.md)
12+
13+
## How to use
714
- Step 1: Clone this repository.
15+
- step 2: Navigate to the folder to execute (Backend or Frontend)
16+
17+
18+
### Connect :
19+
- [Twitter](https://twitter.com/SayedAzharSabri)
20+
21+
- [Linkedin](https://www.linkedin.com/in/sayedazharsabri/)
822

backend/README.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,37 @@
1+
![!\[applogo\](Quiz_App_REST-API.png)](doc/images/Quiz_App_REST-API.png)
2+
13
# Quiz-App-REST-API-TS-Mongoose
24
This is Backend - REST API for a Quiz App build using TypeScript and Mongoose.
5+
### Backend playlist: [Quiz App Backend](https://www.youtube.com/playlist?list=PLIfcYFqzDXHlHjNyVs5J5KCe6B1NYZ7WK)
6+
7+
## Dependencies:
8+
![Static Badge](https://img.shields.io/badge/express-v4.18.2-1?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAMAAABF0y%2BmAAAAbFBMVEX%2F%2F%2F%2F8%2FPz09PT19fX4%2BPjd3d2ampoAAAAzNDWoqKno6Oh0dHRcXFzIycm5ubktLi4hIiN7e3yLi4tmZ2fi4uI9Pj7S0tIHCQuzs7NJSkru7u6goKB%2Bf3%2FW1taNjo69vb1PT1BsbW0VFRc3ODhehn9TAAAA30lEQVR4Ad3QhXHEMBBA0W8QmAVmTq7%2FHjOeDdSQewNiLfBukjRNM4A0TeCR%2F0wSpY0xtiihMgWPsraNnLWd8yFEE3vyOIwAeprhMQ5Lm8O6uT3hWPwKjQspj%2BzsLvlBuwNmV1DaukS%2Bt3sqs8MWkAU7ejMiGnMhkjoCqnZmQ3CZPwM8Hy%2F8Hd7xF7BWzjQIxulCsJaQbG6r7xXR2zNHrn1s0AwhUdNPjunejTLxTlHedS89EOMwFAkobzR4ewFptRyI9tPY18uZkFIYzUO5akWU22BflYKx2xGX1Rn%2Fyxf%2BuwzyBt%2FvSwAAAABJRU5ErkJggg%3D%3D)
9+
![Static Badge](https://img.shields.io/badge/typescript-v5.2.2-1?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAMAAABF0y%2BmAAAANlBMVEUxdsQwd8UxeMYudsQwd8UodMUVbcIfcMOlv%2BPY4%2FNfkdCzyefr8fn%2F%2F%2F9DgsqEqdrO3PDE1uzY59dZAAAABXRSTlMKqv8F%2BjSKPNsAAACwSURBVHgB5Y4BCsUgCECrTXWWVfe%2F7DeGjUE7wX8ERM9XhRDTB%2FFwt7UhfXNupfNnEtCBlIjsgJYkvhyBlEvRctUlszqS9GZJaMysWphztbku0ro8bxJZMZAIL4sIAF%2B%2FrVbYCQ7VUhHSToKo0eVVwi2nLWpk2pRmoU3dYFfawqw6aPNmAyQUl%2B8Suw7Ofq3zyMkMlzSYG8yhlvtgsbkzxCWJzBlAeG9jOOKZtpzx%2BAFmeg3cx68a3wAAAABJRU5ErkJggg%3D%3D)
10+
![Static Badge](https://img.shields.io/badge/mongoose-v7.5.0-1?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAMAAABF0y%2BmAAAAb1BMVEX%2F%2F%2F%2F99%2Ff57%2B%2F%2B%2FPzlysq3c3PSpaWdNjaHAACBAADVq6uvYGCMAACPAAC1bW16AACwZGShQECZLCyQEBB%2BAADCh4eAAACSGRmWJibz5eXHkpLZsrLevr6jSUmoUVHKmJju3t768%2FO8fX2aNTXn0dGi5lwOAAAAsklEQVR4AeXOURqCIBBF4UFUZ1QVFUkw0qz9r7HAUL%2BWUPeFA%2F8LEMYiFpJHUcg4SYGnGRJmub8XJVFVb542grUNdllPsgYYlLpkI6pKe5RCkHknm5CuqbQxB9A3ZT1SiTH4zTSWgvuMerV4JAPbdIlj%2BEstc4%2B4wLZ7Ryt8ZqRxqEYI%2BKAp9CxXh9IeiM8DE4%2FFCZdvFP%2BBTbFjd8LG4dQO4YEJq0PnrXEHh3383PBLewEQBBA5C4H39wAAAABJRU5ErkJggg%3D%3D)
11+
![Static Badge](https://img.shields.io/badge/nodemailer-v6.9.4-1?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAMAAABF0y%2BmAAAAolBMVEX%2F%2F%2F%2Fx%2BvXn9u%2Fi8fjl8%2Fj1%2B%2F3c8eaCzKXU7uDF5vZzxenG5PCAxuBewI50x51Os%2BJXstVtutk2sXSIz6s3rN%2Bd1e8inMqV1bWs2%2FF5v9srn8s8s3eu4MeUyuBMuYO95dFfuuWl0eNDpMpjwZEtpdah2t%2BX1c2DyOnw%2Bf3o6Oisq6vPz8%2F19fXv7%2B%2FBwcHY2NiCgoKRkZG6urqjo6Obm5tra2s7HR5QAAAA0klEQVR4AWIYaoCRCUAFPWABDANRFK1t29r%2FBqs%2FRV4b3sNwSJS4L0m%2BF0XVcNaNT01LBNqOAHQNmUz0fIkwCHlgFEMlP%2FkwSAnd7FI5L%2F5YVsDI1U%2Brkz%2BWQdMCo07n%2BqJgsAxsDRgZ9ZCweOqoAKPptD%2FeObMbQX8opCpaVio%2Fqzd6PyTwGyWdg57jqF6qCQAGYFjllHn%2BpQ1VLE%2BYWEQNyElBXwjc6isji5udh7fbRTzcW%2BJrY7Z2tyqPlfBh8Rmn76lkRKIRFKZqQWoWBr%2FDBSQFHq4LXtBcAAAAAElFTkSuQmCC)
312

413
# What you can learn by exploring
514
- There is JWT authentication in this app
615
- There is express validator and express error routes
716
- There is custom error class.
817
- There is nodemailer used in this.
918

10-
# How to start?
19+
## How to Start ?
1120
- Step 1: Clone this repository.
12-
- Step 2: Run Command - "yarn install" to install all the required packages.
13-
- Step 3: Add environment configuration details to nodemon.json for development.
14-
- Step 4: Run Command - "yarn start:dev" to execute this project on localhost.
21+
- Step 2: To install all the required packages run command:
22+
```sh
23+
yarn install
24+
```
25+
- Step 3: Add environment configuration details to nodemon.json for development.
26+
![!\[config\](carbon.png)](doc/images/carbon.png)
27+
- Step 4: Replace `<DATABASE_CONNECTION_STRING>` with appropriate connection string.
28+
- Step 5: To apply JWT authentication, replace `<ENCRYPTION_SECRET>` with appropriate key.
29+
- Step 6: To use the emailer functionality, replace `<USER_EMAIL>` with an actual email and enable 2-step Verification on it.
30+
- Step 7: Visit manage account of the email and search for **App passwords**![!\[Alt text\](<Screenshot 2023-10-02 191641.png>)](<doc/images/Screenshot 2023-10-02 191641.png>)
31+
and create new app specific password and replace `<USER_PASSWORD>` with that new password.
32+
- Step 8: Replace `<SERVICE_PROVIDER>` with the service provider you wish to use and in this case **smtp.gmail.com** is used.
33+
- Step 9: Replace `<SERVER_BASE_URL>` with **localhost:3000**
34+
- Step 10: To execute this project on localhost run command:
35+
```sh
36+
yarn start:dev
37+
```

backend/doc/images/Quiz_App (3).png

221 KB
Loading
212 KB
Loading
Loading

backend/doc/images/carbon.png

157 KB
Loading

0 commit comments

Comments
 (0)