Background and Description

For this project, you will be creating an application to manage and track different trips for users and a travel agency.

Goals and Objectives

• Use object and array prototype methods to perform data manipulation
• Create a clear and accessible user interface
• Make network requests to retrieve data
• Implement a robust testing suite using TDD
• Write DRY, reusable code that follows SRP (Single Responsibility Principle)

Timeline

Dates and deadlines to be aware of:

Day One Deliverable: Please submit your project here

Tuesday, Week 6 - Project due at 9PM Mountain Time.

Requirements

Workflow

You will want to submit PRs to your accountabilibuddy to:

• You must give your accountabilibuddy collaboration access to your repo.
• You must submit at least 2 PRs to your accountabilibuddy for review.
• You must wait for your accountabilibuddy to review your PRs, and allow THEM to merge any PRs you submit.

It is up to you to decide what changes warrant a PR – remember we want to submit PRs that have significant changes and potential for feedback. Think about what functionality you’re struggling with or have questions about or need help with. As an accountabilibuddy, you are responsible for reviewing at least 2 PRs from your partner.

Technologies

• Fetch API to retrieve and add data
• Mocha and Chai for testing your code
• Webpack

Initial Setup

For this project, you will want to use this Webpack Starter Kit repo. Setup instructions are in the README.

You will also need to clone down this local server and have it running in a separate tab in your terminal each time you run your client.

Endpoints

Below are all the endpoints set up for this project. You may not use all of them – some apply to extensions. Pay attention to the functionality required of each iteration when picking the appropriate endpoint.

Iterations

1. Dashboard

As a traveler:

• I should see a dashboard page that shows me:
  • All of my trips (past, upcoming and pending)
  • Total amount I have spent on trips this year. This should be calculated from the trips data and include a travel agent’s 10% fee

2. Traveler Interaction

As a traveler:

• I should be able to make a trip request:
  • I will select a date, duration, number of travelers and choose from a list of destinations
  • After making these selections, I should see an estimated cost (with a 10% travel agent fee) for the trip.
  • Once I submit the trip request, it will show on my dashboard as “pending” so that the travel agency can approve or deny it.

Refer to the “Add new trip” section from the endpoints table above!

3. Accessibility

• You must be able to tab through your app and use it without a mouse
• Your app must still be usable when tested with a colorblind extension
• You must score as close to 100% as possible with the Lighthouse and WAVE accessibility audits. Be prepared to explain any accessibility audits your application is failing.
• Your HTML must be written semantically and should use ARIA attributes for any UI elements that are not understood by the screen reader (ONLY if needed / appropriate)

4. Login

When first arriving at the site, a user should be able to log in with a username and password.

As a traveler:

• I should be able to login:
  • I will see a login page when I first visit the site:
  • I can log in with the following credentials:

username: traveler50 (where 50 is the ID of the user)
password: travel

• Upon successfully logging in, I should see my dashboard.

Refer to the “Get single traveler” section from the endpoints table above!

5. Agent Interaction (extension)

Your app should now support two different types of users. In addition to having a traveler, you will now add a travel agency.

As a travel agent:

• I should be able to login:
  • I will see a login page when I first visit the site:
  • I can log in with the following credentials:

username: agency
password: travel

As a travel agent, upon logging in:

• I should see a dashboard page that shows me:
  • New trip requests (a user’s “pending” trips)
  • Total income generated this year (should be 10% of user trip cost)
  • Travelers on trips for today’s date (number, names, however you want to display this!)

As a travel agent:

• I should be able to see and approve / deny trip requests
• I should be able to search for any user by name and:
  • View their name, a list of all of their trips, and the total amount they’ve spent (including 10% agent cut)
  • Approve a trip request for that user
  • Delete an upcoming trip for that user

Refer to the endpoints table above for modifying and deleting a single trip

Testing

You should NOT use the original data files in the data directory for testing. These are big files to begin with, and a real-world dataset would have millions of records. That’s far too big to use every time you want to run a test.

Instead, for your tests, you should create small, sample datasets that match the structure of the application data. By creating this sample dataset, you will also know if your functions are working correctly because you can do the calculations by hand with a much smaller dataset.

You are expected to:

• Build a robust testing suite. This might include testing pure functions in your scripts.js.

Remember to test all possible outcomes (happy/sad/etc). Ask yourself:

• Does the function return anything?
• Are there different possible outcomes to test based on different arguments being passed in?

You are not expected to test:

• DOM manipulation / DOM manipulating functions (like document.querySelector(...))
• Fetch calls

Additional Extensions

• The user dashboard should display a countdown to my next trip (if I have any)
• Allow the travel agent to POST suggestedActivities for user trips (see Endpoints table above). This could be based off of a user’s “travelerType” value.
• Allow the travel agent to create new destinations (see Endpoints table above)
• Utilize an npm package - requires permission from instructors
  • Some options include:
    • Micromodal
    • GlideJS
    • InteractJS
    • DayJS
• Add type checking to your application using TypeScript. Setup instructions for adding TypeScript to your project are noted in the README.
• Choose your own extension!

Minimum Professionalism Expectations

• Commits are atomic and frequent, effectively documenting the evolution/progression of the application.
• A project board is utilized (and updated throughout the project) with Github issues and labels.
• Student uses branches, PRs and thorough code reviews to add new code to the main branch.
• The README is formatted well and at a minimum contains:
• Overview of project and goals
• Overview of technologies used, challenges, wins, and any other reflections
• Screenshots/gifs of your app

Rubric

Evaluation

Evaluations will be done live with an instructor. You’ll be asked to step through the various parts of your application including accessibility audit, the user interface, running tests and looking at fetch calls and JavaScript code.