-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from shivang0-0/main
README updated
- Loading branch information
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,30 @@ | ||
# AttendX | ||
|
||
QR based attendance solution for offline events. | ||
## Contributing | ||
|
||
Contributions are always welcome! | ||
|
||
- Create a fork of the project. | ||
|
||
- Clone the project using `git clone https://url-to-your-local-fork`. | ||
|
||
- Navigate to the project directory `cd AttendX`. | ||
|
||
There you go! Make awesome changes and contribute by making a Pull Request. Make sure to properly document the changes/addition you're trying to bring in AttendX. | ||
|
||
|
||
## Run Locally | ||
|
||
- Follow the steps to setup flutter in your system from [official guide](https://flutter-ko.dev/get-started/install). | ||
|
||
- Make sure that `flutter doctor` throws no error/warnings after installation. | ||
|
||
- Navigate to the project directory, and execute `flutter run`, this will prompt you to select the platform. | ||
|
||
![flutter-run-output](https://0x0.st/HhAY.png) | ||
|
||
- Choose one from the list, or connect your Android phone via cable, and turn on USB Debugging from the Developers Option to use your device for hot reload. | ||
## Installation | ||
|
||
Do check the releases, we'll drop a binary very soon. |