Sonickmumba/travel-list

Travel list is a web application where one can manage their travel items: have a list of items to be packed for a journey, so that one can not forget anything for the journey It is built using React and javascript.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Travel-list

Travel list is a web application where one can manage their travel items: have a list of items to be packed for a journey, so that one can not forget anything for the journey It is built using React and javascript.

🛠 Built With

Tech Stack

Languages

• React
• Javascript
• HTML
• CSS

Testing library

• RSpec

Key Features

• [A travel list page]
• [Show how many items have been packed]
• [Show packed items]
• [Delete an item]
• [Sort items in the list]

(back to top)

🚀 Live video

• Live video Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 bundle install

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone git@github.com:Sonickmumba/travel-list.git

Install

Install this project with:

  cd travel-list
  bundle install

Usage

To run the project, execute the following command:

  rails npm run dev

Run tests

The app is tested using Rspec library you can check the tests by opening your terminal, then change the directory to the location of this repo using this command cd file_path, then run this command gem install rspec, finally run this command rspec spec or rspec spec --format doc for documented test results you should see a screen like that comming soon

Deployment

You can deploy this project using:

🚀 Live Demo

• Live Demo Link

(back to top)

👥 Authors

👤 Sonick Mumba

• GitHub: @Sonickmumba
• Twitter: @Sonick
• LinkedIn: Sonick Mumba

(back to top)

🔭 Future Features

• [Have a decent desktop design for the webapp.]
• [Add login to the app.]
• [implement some UX improvements: include transitions and/or animations, etc]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project it a thumb up : 👍 and share this projects with your friends

(back to top)

🙏 Acknowledgments

I would like to thank...

• Gregoire Vella on Behance for the design of the project.
• Microverse for giving the opportunity to learn
• Code reviewers and coding partners
• Hat tip to anyone whose code was used
• Inspiration

(back to top)

📝 License

This project is MIT licensed.

(back to top)