https://github.com/al-rasels/travel-list-react-js-app
Welcome to Travel-List! This React app helps you quickly arrange and manage all the necessary items for your travels.
https://github.com/al-rasels/travel-list-react-js-app
jacascript react-hooks reactjs
Last synced: 4 months ago
JSON representation
Welcome to Travel-List! This React app helps you quickly arrange and manage all the necessary items for your travels.
- Host: GitHub
- URL: https://github.com/al-rasels/travel-list-react-js-app
- Owner: al-rasels
- Created: 2024-09-20T13:42:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-20T14:27:14.000Z (over 1 year ago)
- Last Synced: 2025-03-15T19:39:19.046Z (11 months ago)
- Topics: jacascript, react-hooks, reactjs
- Language: JavaScript
- Homepage: https://travel-list-urc23.netlify.app/
- Size: 171 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
````markdown
# Travel-List
Welcome to Travel-List! This React app helps you quickly arrange and manage all the necessary items for your travels.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)
## Installation
To get started with Travel-List, follow these steps:
1. **Clone the repository:**
```bash
git clone [https://github.com/your-username/travel-list.git](https://github.com/shant0786/travel-list-urc23.git)
cd travel-list-urc23
```
````
2. **Install dependencies:**
```bash
npm install
```
3. **Start the development server:**
```bash
npm start
```
4. Open your browser and navigate to `http://localhost:3000` to see the app in action.
## Usage
Travel-List allows you to add, manage, and track items you need for your trips. Here's how to use it:
1. **Add Items:** Enter the name and quantity of the item you need and click "Add Item."
2. **Mark as Packed:** Click the checkbox next to an item to mark it as packed.
3. **Sort and Clear List:** Use the sorting options to organize your list by input order, description, or packed status. You can also clear the entire list if needed.
4. **View Stats:** The footer displays helpful stats about your packing progress, including the percentage of items packed.
## Features
- **Item Management:** Add items with descriptions and quantities, and toggle their packed status.
- **Sorting Options:** Sort the list of items by input order, description, or packed status.
- **Stats Overview:** View stats about packing progress, including the percentage of packed items.
## Contributing
We welcome contributions! If you'd like to contribute to Travel-List, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Open a pull request.
## License
```
Feel free to customize this README to better fit your project's specifics. Happy coding! 🚀
```