add readme for documentation

This commit is contained in:
Pouya Defaei
2026-05-02 08:52:08 +03:30
parent fc97bc5f59
commit 3edf6ff351
27 changed files with 927 additions and 664 deletions

View File

@@ -1,36 +1,51 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# 🚀 Robin Nework New Client Setup
## Getting Started
Follow these steps to run the frontend locally.
First, run the development server:
---
## 1⃣ Install Dependencies
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
npm install
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
---
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## 2⃣ Create `.env` File
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
Create a `.env` file in the root directory and add:
## Learn More
```env
NEXT_PUBLIC_BACKEND_URL=api.robinnetwork.ir (for example)
NEXT_PUBLIC_BACKEND_URL_LOCAL=http://127.0.0.1:4000
```
To learn more about Next.js, take a look at the following resources:
⚠️ Make sure your backend server is running on port `4000`.
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
---
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## 3⃣ Run the Application
## Deploy on Vercel
```bash
npm run build
npm start
```
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
---
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
## ✅ Application URL
After running the command, the app will be available at:
```
http://localhost:3000
```
---
## 📝 Notes
- Restart the server after changing environment variables.
- Ensure the backend is running before testing API requests.
- `NEXT_PUBLIC_` variables are exposed to the browser.