https://github.com/luigirazum/book-destinations
https://github.com/luigirazum/book-destinations
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/luigirazum/book-destinations
- Owner: luigirazum
- License: mit
- Created: 2024-03-07T08:25:26.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-03-21T20:29:49.000Z (over 1 year ago)
- Last Synced: 2025-01-11T01:12:01.304Z (9 months ago)
- Language: JavaScript
- Size: 991 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Book Destinations
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**[Book Destinations]** This application helps users book travel destinations around the globe. Users are able to create accounts and upload thier own destinations, reserve them. Users can plan their journey with a quote provided during booking. The application uses data from Rails api, this is handled using redux toolkit. [Backend Application]().
ViteJs
Server
Database
- **[User authentication and login]**
- **[Redux to handle state]**
- **[Users can add thier respective Destinations and reserve others]**
> Not live yet...
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Install Npm.
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd book-destinations
git clone git@github.com:/book-destinations.git
```
-
### Install
Install this project with:
Example command:
```sh
cd book-destinations
npm install
```
-
### Usage
To run the project, execute the following command:
Example command:
```sh
npm run dev
```
-
### Run tests
To run tests, run the following command:
Example command:
```sh
npm test
```
-
### Deployment
You can deploy this project using:
render
👤 **Austin Obimbo**
- GitHub: [@obimbo07](https://github.com/obimbo07)
- LinkedIn: [LinkedIn](https://linkedin.com/in/austin-obimbo)
- WellFound: [WellFound](https://wellfound/u/austin-obimbo)
- [ ] **[Add more models to output diffrent data]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project contribute new features. I would love that.
I would like to thank microverse for their guidance on the project.
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Can I contribute?]**
- [Yes, your welcome to contribute, I value pair-programming]
This project is [MIT](./License) licensed.