Skip to content

Commit 48ea8bd

Browse files
committed
Update README
1 parent aa1c4e5 commit 48ea8bd

2 files changed

Lines changed: 19 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,67 @@
11
# QR Code Ticket
22

3-
This service generates a unique qr code for each registered user and also provides a qr reader for the receptionist to verify each ticket powered by Fastapi
3+
This service generates a unique qr code for each registered user and also provides a qr reader for the receptionist to
4+
verify each ticket powered by Fastapi
45

56
## Screenshot
67

7-
![ticket](ticket.png)
8+
| Ticket | Qr scanner |
9+
|-----------------------|-------------------------------|
10+
| ![ticket](ticket.png) | ![qr scanner](qr_scanner.png) |
811

912
## Getting Started
13+
1014
Clone repository
15+
1116
```bash
1217
git clone https://github.com/sadjadeb/qrCode_ticket.git
1318
```
1419

1520
### Prerequisite
21+
1622
Create an environment to run the app
23+
1724
```bash
1825
cd qrCode_ticket/
1926
sudo apt-get install virtualenv
2027
virtualenv venv
2128
source venv/bin/activate
2229
```
30+
2331
Install required libraries
32+
2433
```bash
2534
pip install -r requirements.txt
2635
```
36+
2737
\
2838
Rename sample_config to config and replace mock data with valid ones
2939

3040
## Run
3141

3242
Run the following command to start the webserver
43+
3344
```bash
3445
python main.py run_webserver
3546
```
3647

3748
Run the following command to add ticket ids and links for registered users
49+
3850
```bash
3951
python main.py generate_ticket_link
4052
```
53+
4154
\
42-
Now open the base url and pass the specified user's ticket_id as a query parameter to see the ticket
55+
Now open the base_url/ticket/ticket_id to see the ticket
4356

44-
For the receptionist, get the /reception endpoint and enter the password to open the QR code reader
57+
For the receptionist, get the /reception endpoint and enter the password to open the QR code reader and verify the ticket
4558

4659
## Contributing
60+
4761
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
4862

4963
Give a ⭐️ if you like this project!
5064

5165
## License
66+
5267
[MIT](https://github.com/sadjadeb/qrCode_ticket/blob/master/LICENSE)

qr_scanner.png

262 KB
Loading

0 commit comments

Comments
 (0)