https://github.com/vicradon/free-lunch-app

This is an API for an app that allows employees to gift each other free lunch tokens
https://github.com/vicradon/free-lunch-app

Last synced: about 1 month ago
JSON representation

This is an API for an app that allows employees to gift each other free lunch tokens

• Host: GitHub
• URL: https://github.com/vicradon/free-lunch-app
• Owner: vicradon
• Created: 2023-09-27T00:08:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-27T06:04:28.000Z (over 1 year ago)
• Last Synced: 2024-04-28T06:36:03.680Z (9 months ago)
• Language: CSS
• Size: 504 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Free Lunch App

This is a complete full-stack project for employees in an organisation to send lunches to each other. It is a structured like a multi-tenant application such that an employee will have one account but can belong to more than one organisation (think Slack).

## Repository Structure

The repository contains both the frontend and backend code. The frontend is a React.js frontend application packaged with Vite and the backend is an Express application. Both the frontend and backend are written in Typescript.

## Database Diagram

You can view the diagram and relationships of the models in the diagram below:

![Database Diagram](./docs/free-lunch-db-diagram.png)

## Application Flow

The image below shows the user flow through the application in gifting lunch and seeing their lunch balance.

![User flow](./docs/user-flow.png)

## Contributing

If you would like to suggest package updates or new necessary features, feel free to open a PR.

## LICENCE

MIT