README.md

Travel Planner

A web-based app for planning gear to bring for hiking/bikepacking/moto-camping trips.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Create an Item
   • Update an Item
   • Delete an Item
   • Fetch a Specific Item
   • Fetch All Items
   • Access API Documentation
4. Roadmap
   • Version 1
5. Contributing
   • Testing
   • Linting & Formatting
6. License
7. Contact
8. Acknowledgments

About The Project

Travel Planner is a web-based application for planning your next adventure. Current features include the ability to create, list, update and delete items on your packing list.

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You will need the following software installed in your environment to run this app.

• node >= 18.2.0
• yarn >= 1.22.19

Installation

1. Clone the repo

   git clone https://github.com/jakec-dev/travel-planner.git

2. Install packages

   yarn install

3. Build the app

   yarn build

4. Start the server

   yarn start

(back to top)

Usage

The app provides the following functionality:

View All Items

Navigate to https://localhost:8080 to see your gear list.

(back to top)

Get Detailed Information About an Item

Click the checkbox next to the item you wish to inspect in your gear list. You should see the item displayed in the sidebar.

(back to top)

Add an Item

Enter the item Item name and Brand (optional) in the Add Item form, then click the Add Item button.

(back to top)

Update an Item

Select the item to modify from your gear list, then click the Edit icon next to the field you wish to update in the sidebar. Make your desired changes, then click the Save icon to save the changes or the Cancel icon to cancel the changes. You should now see the item has been updated in your gear list.

(back to top)

Delete an Item

Click the Delete icon next to the item you wish to delete from your gear list. This action is permanent and the current version of this app does not prompt you for confirmation, so please ensure you really wish to delete the item before clicking the icon.

(back to top)

Roadmap

Version 1

• Display all items on page
• Add ability to create, read, update and delete an item
• Use the Travel Planner Server's API to persist data
• Write unit and integration tests
• Write project documentation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Testing

This project uses Jest and React Testing Library for testing, and Jest for test coverage reports

yarn test
yarn test:coverage

(back to top)

Linting & Formatting

This project uses ESLint for linting using AirBNB's style guide, and Prettier for formatting.

yarn lint
yarn lint:fix

yarn format
yarn format:write

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Jake Clayton

  e: [email protected]

  w: jakec.dev

  

(back to top)

Acknowledgments

• Harrison Croaker

(back to top)