Skip to content

Tipper-final-project/front-end

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to Tipper! 👋

Our cashless tipping web-app! Through Tipper, service providers such as waiters, are able to be tipped directly in to their bank accounts. Upon scanning a QR Code linked to the service provider's registered Tipper account, the tippee can complete a payment authenticated by Stripe.

Install

In order to use this repo and run it locally, you will need to do the following:

  1. Clone the repo from gitHub on your local machine
$ https://github.com/Tipper-final-project
  1. Install Packages & Dependencies This project uses node version v20.6.1 and npm version 9.8.1 Go check them out if you don't have them locally installed. You can run the command below to install all the necessary packages.
$ npm install

** IMPORTANT **

You will need to create the necessary environment variables in the top level of your folder

Please create the files:

  1. .env
  2. .env.local

Inside the .env file, add these 2 variables:

NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=

STRIPE_SECRET_KEY=

see .env.example for reference


Inside the .env.local file, add the following variable:

NEXT_PUBLIC_SECRET=

Run Project

You can now run the project:

$ npm run dev

To use the App

Firstly, you will need to register an account and fill in the required fields.

Making a Test Payment

You will be taken to the payment page after scanning the QR Code. When filling in the payment form, use the long card number 4242 4242 4242 4242.

  • Use a valid future date, such as 12/75.
  • Use any three-digit CVC (four digits for American Express cards).
  • Use any value you like for other form fields i.e. test@pay.co.uk

Checking payment on Stripe

To check confirmation of Stripe payments:

  1. Go to Payments
    payments tab

  2. Toggle on Test Mode
    test mode

  3. Select All Payments
    all payments

Authors

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

Releases

No releases published

Packages

No packages published

Contributors 6