Skip to content

Latest commit

 

History

History
159 lines (102 loc) · 5.59 KB

README.md

File metadata and controls

159 lines (102 loc) · 5.59 KB
Raw

Profile Navigator

A simple dashboard with only 2 routes:

  • Home
    • Renders all the customers
  • Customer profile
    • Renders individual customer details

Data fetched from Free fake API{JSON} placeholder

Visit the Profile Navigator site here

Styling

Project styled with Bootstrap 5

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

Convert to Typescript

To get started, create an empty tsconfig.json file in the root of your project:

touch tsconfig.json

Start the development server by running npm run dev

Next.js will automatically detect TypeScript usage and install the required packages

Follow the steps at convert your app to Typescript

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

How to fix cannot find module css/scss

Declare a new module in the next-env.d.ts file

- error ./pages/_app.tsx:2:0
Module not found: Can't resolve '@/styles/globals.css'
  1 | import 'bootstrap/dist/css/bootstrap.css';
> 2 | import '@/styles/globals.css'
https://nextjs.org/docs/messages/module-not-found

getStaticProps OR getServerSideProps

The choice to use either of the mentioned functions above depends on the requirements of the application and the nature of the data being fetched

A simple distinction

getServerSideProps: Use getServerSideProps when you need to fetch data on each request or when the data is frequently updated

This function runs on the server-side and generates the page on each request, providing fresh data every time

It's useful when you have dynamic data that needs to be fetched at the time of the request, such as personalized content, user-specific data, or real-time data.

getStaticProps: Use getStaticProps when you have data that can be pre-rendered at build time and does not change frequently

This function runs at build time and fetches data to generate static HTML pages

The generated HTML pages can be cached and served to multiple users, improving performance.

It's suitable for content that does not require frequent updates like:

  • blog posts
  • marketing pages
  • OR static data

Conclusion

Choose getServerSideProps for dynamic data that needs to be fetched on each request and getStaticProps for pre-rendering static data that doesn't change often and can be cached for improved performance

Testing with Cypress

Cypress interacting with elements

Manual setup of the cypress package and writing tests

Cypress End to End Testing Framwork Youtube Tutorial LInk

Important --> Running your Cypress Tests

Since Cypress E2E tests are testing a real Next.js application they require the Next.js server to be running prior to starting Cypress

We recommend running your tests against your production code to more closely resemble how your application will behave

Run npm run build and npm run start, then run npm run cypress -- --e2e in another terminal window to start Cypress and run your E2E testing suite

Explanation of the test in app.cy.ts

describe('Navigation', () => {
  // starts from the home/index page
  it('should navigate to the customer profile page', () => {
    cy.visit('http://localhost:3000/');

    // capture the dynamic [id] parameter from the URL
    cy.get('a[href*="/customers/"]').first().invoke('attr', 'href').then((href) => {

      /**
       * first get the href attribute
       * extract the id by splitting(/) 
       * & getting the last segment
       * 
       */
      const customerId = href?.split('/').pop();
      /**
       * first() Get the first DOM element within a set of DOM elements
       * {force: true} forces the click event
       */
      cy.get('a[href*="/customers/"]').first().click({force: true});

      // assert the URL contains the expected pattern
      cy.url().should('include', `customers/${customerId}`);

      // assert the following h6 heading is contained in the page
      cy.get('h6').contains('Return to Home Page');
    });
  });
});
const customerId = href?.split('/').pop();

The split('/')method splits the href string into an array using the delimiter '/'

Then, the pop() method retrieves the last element from the array, which in this case is the customer ID

cy.get('a[href*="/customers/"]').first().click();

In the above line of code, Cypress is locating the first anchor element (a) that has a href attribute containing "/customers/"

It then triggers a click on that element