diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..b493288 --- /dev/null +++ b/readme.md @@ -0,0 +1,43 @@ +# Padre Gino's Pizza + +Padre Gino's Pizza is a web application for ordering pizzas online. This project is built using React, Vite, and TanStack Router. It includes features such as viewing the pizza of the day, creating orders, viewing past orders, and submitting contact forms. + +## installation + +```sh +npm install +``` + +## Development + +```sh +npm run dev +``` + +## Building + +```sh +npm run build +``` + +## Testing + +```sh +npm run test +``` + +--- + +## Key Files and Directories + +App.jsx: The main entry point of the React application. +Cart.jsx: Component for displaying the cart. +contexts.jsx: Context for managing the cart state. +ErrorBoundary.jsx: Error boundary component. +Header.jsx: Header component with navigation. +Modal.jsx: Modal component for displaying modals. +Pizza.jsx: Component for displaying a pizza. +PizzaOfTheDay.jsx: Component for displaying the pizza of the day. +api: Directory containing API functions. +routes: Directory containing route components. +__tests__: Directory containing tests. \ No newline at end of file