Favoura | IOU Favour Tracker Web App Client

Table Of Contents

• About the Project
• Built With
• Installation and Usage
  • Prerequisites
  • Installation
• Roadmap
• License
• Acknowledgements

About The Project

Favoura is a tracking system for “IOU”s or “favours”. An “IOU” is an abbreviation of "I owe you", and it is an informal acknowledgement of a debt or favor owed. This system allows groups or teams to log in and record the favors that they owe to each other. In addition to recording favors, Favoura allows users to post public requests with an offer to provide a favor (the reward), as well as view a leaderboard to see who is fulfilling the most requests.

Built With

The following technologies were used to build this web app:

• React.
• TailwindCSS.
• AWS Cognito.

Application Contents

Src Directory

• Components - A directory containing the React components used in this web app.
• Contexts - A directory containing the React contexts used in this web app.
• Hooks - A directory containing the React hooks used in this web app.
• Views - A directory containing the the main React pages used in this web app.
• Utility - A directory containing commonly used functionality used in this web app.

Utility Directory

• ErrorMessageUI.js - Gets fed error codes, and outputs the text that is intended to be displayed to the user.
• UserPool.js - Contains user pool data intended to be used for connecting to our AWS Cognito authentication service.
• Util.js - Contains commonly used functions used throughout this web app.

App Working Directory

• node-modules - Generated when running 'npm install'. A directory containing the NPM package dependencies used by this server.
• package.json - Package.json file used with NPM.
• package-lock.json - Package-lock.json file used with NPM.

Installation and Usage

Prerequisites

• Node.JS
• NPM

npm install npm@latest -g

Installation

1. Clone this repository.
2. In the newly cloned repository, open your command line and run the 'npm install' command to download the required packages.
3. Run the 'npm start' command to run the server. (see the package.json for other scripts available to run).
4. The Favoura front-end client is now ready. Try out the following unauthenticated REST requests below.

Roadmap

See the open issues for a list of proposed features (and known issues).

License

AIP-A2-IOU-Tracker-Server is copyright (c) 2020, Aryan Nateghnia [email protected].

Acknowledgements

• Sukonrat Kanjanasuttiyakorn
• Mohammad Karim