Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andriypapirnyk/qr

Group Project
https://github.com/andriypapirnyk/qr

express mongoose nodejs qrcode react scss ts vite

Last synced: about 1 month ago
JSON representation

Group Project

Awesome Lists containing this project

README

        

![Logo](https://qrcode-app.co/img/logo-big.png)

# QR

A group project that helps to verify the device by scanning a qr code and entering the results

## Tech Stack

**Client:** React, Vite, TS, SCSS

**Server:** Node.js, Express, Mongodb, Mongoose

## Deployment

To deploy this project run

client:
```bash
npm i
npm run dev
```

server:
```bash
npm i
npm start
```

## Client Routing

Get main page:
```bash
/
```

Get rating page:
```bash
/rating
```

## API Reference

#### Get all items

```http
GET comming soon
```

| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `api_key` | `string` | **Required**. Your API key |

#### Get item

```http
GET comming soon
```

| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `id` | `string` | **Required**. Id of item to fetch |

## Features

- user authorization by scanning a QR code
- management of scan results by the unique ID of the device
- scanning limit (1 time per day)
- strict typing of data using TS

## Screenshots

![App Screenshot](https://ibb.co/w0wtLSm)
![App Screenshot](https://ibb.co/N6B4G7p)

## Authors

- [AndriyPapirnyk](https://github.com/AndriyPapirnyk)
- [OstapoKapo](https://github.com/OstapoKapo)
- [AndriyStep12](https://github.com/AndriyStep12)
- [Maksimgnam](https://github.com/Maksimgnam)
- [RomanM0](https://github.com/RomanM0)

## Feedback

If you like our work, please subscribe and add a star to this project :)