Travlr

Keep track of all your future travel destinations with Travlr!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • How Its Made
2. Getting Started
   • Installation
   • Usage
3. Optimizations
   • Future Improvements
   • Lessons Learned
4. Roadmap
5. Contact
6. Acknowledgments

About The Project

Travlr is a CRUD application that allows users to eep track of all thier future travel destinations in one place. Create a running log of the location and travel time, along with any notes for places to visit in the future.

Features

• Create and store destinations
• Location lookup - Find a destination via autocompleted suggestions or enter in your own
• Add time frame for visit
• Add notes along with destination
• Edit and delete destination entries

How Its Made

The application is built with the following technologies:

Getting Started

If you would like to use Travlr online, visit https://travlr.onrender.com/.

To get a local copy of the application up and running follow these simple example steps.

Installation

Follow the steps below to set up the application locally.

1. Make a MongoDB account and create a new cluster database to store information for the application.

2. Sign up for RoadGoat and Unsplash accounts to recieve free API keys.

3. Clone the repo

   git clone https://github.com/tdo95/travlr.git

4. Install NPM packages

   npm install

5. Create an .env file and add your API keys, secrets, and database string shown below

   DB_STRING="ENTER DB STRING HERE"
   ROADGOAT_KEY="ENTER KEY HERE"
   ROADGOAT_SECRET="ENTER SECRET HERE"
   UNSPLASH_KEY="ENTER KEY HERE"

Usage

1. To start the API server, run the following command

    npm run start  

   Alternatively, you can run with nodemon

    npm run dev  

2. Navigate to the application using the url below

   "localhost:8000"

Optimizations

Future Improvements

• Expand explore section to support location lookup and browsing

Lessons Learned

• How to use logic to traverse webpages with inconsistent document structures
• Remove accent marks from text using the normalize() and replace() methods
• Scrapping across sites without standardized document structures is difficult and ineffienct, should look into how to approach this effectively

Roadmap

• Configure create, update and delete routes to store and edit entries in database
• Implement location search autocomplete
• Implement image grabing from pixibay incase no image provided
• Optimize ellipis button to block all interaction until closed
• Allow users to unset month and year on cards

Contact

Tee O.

Portfolio: www.github.com/tdo95

(back to top)