diff --git a/README.md b/README.md index a36934d..dd85703 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ -# React + Vite +# NearleDaily Developer Docs -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +Welcome to the NearleDaily Developer Documentation portal. -Currently, two official plugins are available: +This project is a React and Vite based application that provides a beautiful, modern, two-pane API documentation interface for integrating with NearleDaily's backend services including Users, Orders, Tenants, Products, and Locations. -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs) -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) +## Getting Started -## React Compiler +### Prerequisites +- Node.js (v20.x or above) -The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation). +### Running Locally -## Expanding the ESLint configuration +1. Install dependencies: + ```bash + npm install + ``` -If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project. +2. Start the development server: + ```bash + npm run dev + ``` + +3. Open your browser and navigate to `http://localhost:5173` + +## Built With +- React +- Vite +- Tailwind CSS +- Lucide Icons