Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marco-rosner/bookingparadises

Booking Paradises was built using Typescript, ReactJS, Material UI, Vite, React Router, Hooks, Context API, React Redux, Jest (Unit Tests) and Cypress (E2E Tests)
https://github.com/marco-rosner/bookingparadises

context-api cypress docker github-actions hooks jest material-ui react-redux react-router reactjs typescript vite

Last synced: 12 days ago
JSON representation

Booking Paradises was built using Typescript, ReactJS, Material UI, Vite, React Router, Hooks, Context API, React Redux, Jest (Unit Tests) and Cypress (E2E Tests)

Host: GitHub
URL: https://github.com/marco-rosner/bookingparadises
Owner: marco-rosner
License: mit
Created: 2024-02-06T21:18:13.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-04-30T18:08:45.000Z (7 months ago)
Last Synced: 2024-04-30T19:28:59.016Z (7 months ago)
Topics: context-api, cypress, docker, github-actions, hooks, jest, material-ui, react-redux, react-router, reactjs, typescript, vite
Language: TypeScript
Homepage:
Size: 3.91 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Unit Test workflow](https://github.com/marco-rosner/bookingparadises/actions/workflows/tests.yml/badge.svg)](https://github.com/marco-rosner/bookingparadises/actions/workflows/tests.yml) [![E2E Test workflow](https://github.com/marco-rosner/bookingparadises/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/marco-rosner/bookingparadises/actions/workflows/e2e-tests.yml)

# Booking Paradises

Booking Paradises is a mobile-friendly application that manages bookings for amazing places where you can live perfect moments with your loved ones.

![Booking Paradises](./client/src/assets/bookingParadises.png?raw=true "Booking Paradises")

The project was built using Typescript, ReactJS, Material UI, Vite, React Router, Hooks, Context API, React Redux, Jest (Unit Tests) and Cypress (E2E Tests).

## Run the project

### Using Docker Compose

```sh
docker-compose up
```

### Using Docker

To run this project using Docker run these commands:

#### Client

```sh
cd client && docker build . -t marcorosner/bookingsparadises-client

docker run -p 5173:5173 -d marcorosner/bookingsparadises-client
```

#### Server

```sh
cd server && docker build . -t marcorosner/bookingsparadises-server

docker run -p 8080:8080 -d marcorosner/bookingsparadises-server
```

### Standalone versions

#### Client

Install the dependencies:

```sh
cd client && yarn
```

Run in the dev mode:

```sh
cd client && yarn dev
```

Served at http://localhost:5173

#### Server

Install the dependencies:

```sh
cd server && yarn
```

Run in the dev mode:

```sh
cd server && yarn dev
```

Served at http://localhost:8080

## Scripts on client

There are many scripts in `package.json` like:

- start - run the Vite server exposing the host
- dev - run the Vite server in dev mode
- test - run the unit tests using jest
- test:watch - run the unit tests with watch mode
- test:coverage - create the coverage report (actual with 90.58%)
- test:e2e - run the server and the E2E tests
- build - build the project for production using Vite
- lint - check lint rules using ESlint

## GitHub Actions

To prevent regression defects, two GitHub Actions was created [Unit Test](https://github.com/marco-rosner/bookingparadises/actions/workflows/tests.yml) and [E2E Test](https://github.com/marco-rosner/bookingparadises/actions/workflows/e2e-tests.yml).

## Future work

- HighlightTrack and TinyTrack with slides
- ...