Skip to content

Commit

Permalink
[Issue 2498] update frontend readme for current file structure (#2247)
Browse files Browse the repository at this point in the history
  • Loading branch information
doug-s-nava authored Oct 16, 2024
1 parent f123df9 commit 881914b
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,22 @@
│ └── 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
```

## 💻 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

Expand Down

0 comments on commit 881914b

Please sign in to comment.