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

Create REAEME.md #24

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
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
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Soundless-check-in

![euphony_logo](https://user-images.githubusercontent.com/8490058/129358383-14b6f34d-9264-4c49-9538-3ef2e62a6490.png)

This is a check-in application that identifies visitors, especially effective during the COVID-19.
This application stores below informations in database
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to apply the enter one more time.

Suggested change
This is a check-in application that identifies visitors, especially effective during the COVID-19.
This application stores below informations in database
This is a check-in application that identifies visitors, especially effective during the COVID-19.
This application stores below informations in database.

> Visitor's phone number
> Visitor's residential area
> Information of company that they visit

## Reason for making this application

The existing 'QR code check-in' has the following problems.

* If the lens of the device receiving the data is dirty, it is not recognized well.
* If the surroundings are too bright or too dark, it is not recognized well.
* The process of accessing QR codes is complicated, especially for the elderly.

But, This application has no such inconvenience as using sound wave communication.

## Run the app
* ### Visitor

<img src="https://user-images.githubusercontent.com/88221233/131171579-b1764fac-3113-4c3c-a3d8-a3a05293747a.png" width="250" height="400"/> <img src="https://user-images.githubusercontent.com/88221233/131210946-1699ae82-1fb9-4316-84fe-d4eefb7f07c5.png" width="250" height="400"/> <img src="https://user-images.githubusercontent.com/88221233/131171850-6826b0ca-af2d-4819-98c3-97268812404d.png" width="250" height="400"/>
1. Press setting icon
2. Enter your phone number, and residential area
3. Check your information, and press 'CHECK IN'

* ### Company

<img src="https://user-images.githubusercontent.com/88221233/131173092-734265c0-2cfa-41a6-91c5-c2dcc38f916d.png" width="250" height="400"/> <img src="https://user-images.githubusercontent.com/88221233/131173182-922e3e0d-bfe4-45fb-a444-eea690742993.png" width="250" height="400"/> <img src="https://user-images.githubusercontent.com/88221233/131173224-6939d699-1c70-4516-87b6-0bb442cb5f5e.png" width="250" height="400"/>
1. Press setting icon
2. Enter the company information.

## Report Issues

To report a specific problem or feature request, [please open a new issue](https://github.com/euphony-io/soundless-check-in/issues/new/choose).
Your participation drives the development of the application!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please apply Enter to this part as well!

Suggested change
To report a specific problem or feature request, [please open a new issue](https://github.com/euphony-io/soundless-check-in/issues/new/choose).
Your participation drives the development of the application!
To report a specific problem or feature request, [please open a new issue](https://github.com/euphony-io/soundless-check-in/issues/new/choose).
Your participation drives the development of the application!


## Library

It is based on Euphony library.
Official Facebook Page : https://www.facebook.com/euphonyproject
Official Library Site : https://dev.jbear.co/euphony
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please apply Enter to this part as well.

Suggested change
It is based on Euphony library.
Official Facebook Page : https://www.facebook.com/euphonyproject
Official Library Site : https://dev.jbear.co/euphony
It is based on Euphony library.
Official Facebook Page : https://www.facebook.com/euphonyproject
Official Library Site : https://dev.jbear.co/euphony