-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md with proper description
- Loading branch information
Showing
1 changed file
with
30 additions
and
10 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,16 +1,36 @@ | ||
| # kwiz_v2 | ||
| # Kwiz - A Mobile Quiz App Project (for Android and iOS) | ||
|
|
||
| A new Flutter project. | ||
| ## A fully functional mobile quiz creation and sharing platform made with Flutter and Firebase | ||
|
|
||
| ## Getting Started | ||
| ## Basic features | ||
|
|
||
| This project is a starting point for a Flutter application. | ||
| * Login and registration for users | ||
| * Browsable categories section. | ||
| * Quiz randomizer function. | ||
| * Search functions to search for a quiz in a list view, or to search for a particular user in user views. | ||
| * View friends, send a friend request, and accept friend requests to add friends. | ||
| * View all quizzes, and quizzes by category. | ||
| * Take any quizzes submitted by any users on the platform, be marked and scored at the end. | ||
| * View past quiz attempts. | ||
| * Create own authored quizzes and add them to the platform. | ||
|
|
||
| A few resources to get you started if this is your first Flutter project: | ||
| ## Advanced features | ||
|
|
||
| - [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) | ||
| - [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) | ||
| * Ability to challenge friends to a quiz, and to view challenge progress states. | ||
| * Users can rate quizzes that factor into a global rating. | ||
| * Add bookmarks to save quizzes. | ||
| * Quizzes can consist of a range of question types (true/false, fill in the blank, short answer, multiple choice, dropdown, ranking). | ||
| * Global leaderboard displaying all users ranked against each other using average scoring calculation. | ||
|
|
||
| For help getting started with Flutter development, view the | ||
| [online documentation](https://docs.flutter.dev/), which offers tutorials, | ||
| samples, guidance on mobile development, and a full API reference. | ||
| ## Team members | ||
|
|
||
| * [Michael Sent](https://github.com/Michael-Sent) | ||
| * [Kago Motlhabane](https://github.com/kaglet) | ||
| * [Christine Bau](https://github.com/mei-cb) | ||
| * [Luca von Mayer](https://github.com/luca-vm) | ||
| * [Michael Kavai](https://github.com/mchlkavai) | ||
| * [Aidan-Brickhill](https://github.com/Aidan-Brickhill) | ||
|
|
||
| ## Screenshots | ||
|
|
||
| _To be added_ |