31 lines
659 B
Markdown
31 lines
659 B
Markdown
# NearleDaily Developer Docs
|
|
|
|
Welcome to the NearleDaily Developer Documentation portal.
|
|
|
|
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.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
- Node.js (v20.x or above)
|
|
|
|
### Running Locally
|
|
|
|
1. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
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
|