From 881914b30ad4f08dbb474a9e4c2b559836945f34 Mon Sep 17 00:00:00 2001 From: doug-s-nava <92806979+doug-s-nava@users.noreply.github.com> Date: Wed, 16 Oct 2024 13:26:05 -0400 Subject: [PATCH] [Issue 2498] update frontend readme for current file structure (#2247) --- frontend/README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/frontend/README.md b/frontend/README.md index fb8386252..08f03a623 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -13,9 +13,8 @@ │ └── locales # Internationalized content ├── src # Source code │ ├── components # Reusable UI components -│ ├── pages # Page routes and data fetching -│   │ ├── api # API routes (optional) -│   │ └── _app.tsx # Global entry point +│ ├── app # Page routes and data fetching +│   │ └── api # API routes (optional) │ └── styles # Sass & design system settings ├── stories # Storybook pages └── tests @@ -23,15 +22,13 @@ ## 💻 Development -[Next.js](https://nextjs.org/docs) provides the React framework for building the web application. Pages are defined in the `pages/` directory. Pages are automatically routed based on the file name. For example, `pages/index.tsx` is the home page. - -Files in the `pages/api` are treated as [API routes](https://nextjs.org/docs/api-routes/introduction). An example can be accessed at [localhost:3000/api/hello](http://localhost:3000/api/hello) when running locally. +[Next.js](https://nextjs.org/docs) provides the React framework for building the web application. Pages are defined in the `app/` directory. Pages are automatically routed based on the file name. For example, `pages/[locale]/page.tsx` is the home page. [**Learn more about developing Next.js applications** ↗️](https://nextjs.org/docs) ### Getting started -The application can be ran natively or in a Docker container. +The application can be run natively or in a Docker container. #### Native