# shipme-frontend
The ShipME front end application provides a graphical user interface for interacting with the ShipME API to retrieve and manipulate data.

The app is written in [React](https://react.dev/) (TypeScript), and relies on [React Bootstrap](https://react-bootstrap.netlify.app/docs/getting-started/introduction) and [Bootstrap 5.3](https://getbootstrap.com/docs/5.3/getting-started/introduction/).

## Project Structure
The React application is powered by [Vite](https://vite.dev/) and is exposed on port `5173`.

Here's some of the most important information to know about the front end project:

1. A series of API wrapper functions (such as `getOrders()`, `createOrder()`, etc.) are provided in [src/api/](src/api). These handle the process of fetching the ShipME API, as well as error handling through `FetchError` ([FetchHelper.ts](src/utils/FetchHelper.ts)].
2. The primary file which defines the site layout is [App.tsx](src/App.tsx). Page content contained within are defined in [src/pages/](src/pages).
3. The routing configuration for the application is defined in [AppRoutes.tsx](src/AppRoutes.tsx), and the exported `routes` array can be used in cases where route information is required (i.e., conditionals).