Skip to content

Commit

Permalink
Update readme with preview and db image
Browse files Browse the repository at this point in the history
  • Loading branch information
0nn0 committed Apr 25, 2023
1 parent 14a4d95 commit 8c7e063
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 21 deletions.
35 changes: 14 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<h2 align="center">Bookie</h1>
<h2 align="center">Bookie</h2>
<p align="center">
Manage your shared holiday home<br />
Manage your holiday home through a shared calendar<br />
<a href="https://bookie-twentytwo.vercel.app/">View app</a>
</p>

---
![Preview of UI](preview.png)

A small web application that allows you to manage your shared holiday home through a calendar.
## About this project

It is built with the following technologies:
Bookie is a user-friendly platform designed to assist families and friends in managing their jointly owned vacation homes.

### Tech stack

- [ReactJS](https://react.dev/)
- [NextJS](https://nextjs.org/)
Expand All @@ -17,7 +19,7 @@ It is built with the following technologies:

## Getting Started

### Prerequisites
### Requirements

- Node.js (version 18.2.0)
- npm
Expand All @@ -38,22 +40,13 @@ It is built with the following technologies:

The app is hosted on [Vercel](https://vercel.com/). Every commit pushed to the `main` branch will trigger a Production Deployment.

## Dates

Dates in the Postgres database are stored in the the ISO 8601 format (YYYY-MM-DD). There is no time information stored.
When working with dates in the front-end, a date is parsed to a Date object using date-fns.
## Database

## Todo
### Diagram

### High priority
![Database diagram](database-diagram.png)

- Add ability to change booking dates

### Medium priority
## Dates

- Add Supabase setup to readme
- Add preview to readme
- Merge PropertyForm (new) and PropertyDetailsForm (update)
- Design list items in Guests (currently placeholder for avatar and empty line for name)
- Create constant for filters
- Remove bookings, avatar image when deleting account
Dates in the Postgres database are stored in the the ISO 8601 format (YYYY-MM-DD). There is no time information stored.
When working with dates in the front-end, a date is parsed to a Date object using date-fns.
Binary file added database-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 8c7e063

@vercel
Copy link

@vercel vercel bot commented on 8c7e063 Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.