114 lines
3.1 KiB
Markdown
114 lines
3.1 KiB
Markdown
# **Tanami Capital**
|
|
|
|
**Tanami** is a cutting-edge fintech platform designed to streamline investment opportunities for users in the Gulf region. It features two main components:
|
|
|
|
- **Admin Panel:** A web-based dashboard for managing users, monitoring transactions, and overseeing investments efficiently.
|
|
- **Mobile Application:** A user-friendly app that empowers individuals to invest in diverse asset classes, including real estate, private equity, and other financial instruments located in Gulf countries.
|
|
|
|
---
|
|
|
|
## **Key Features**
|
|
- **Regional Focus:** Exclusively operational in Gulf countries, offering investment opportunities tailored to the region.
|
|
- **Diverse Investment Options:** Enables users to invest in financial instruments like real estate and private equity with ease and transparency.
|
|
- **Comprehensive Admin Tools:** The admin panel offers robust tools for tracking and managing platform activity.
|
|
|
|
---
|
|
|
|
## **Current Status**
|
|
The project is **live and operational**, catering specifically to the investment needs of users in the Gulf region.
|
|
|
|
---
|
|
|
|
## **Table of Contents**
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [Environment Variables](#environment-variables)
|
|
- [Scripts](#scripts)
|
|
- [License](#license)
|
|
|
|
---
|
|
|
|
## **Installation**
|
|
|
|
### **Prerequisites**
|
|
- [Node.js](https://nodejs.org/) (version 14 or higher recommended)
|
|
- [npm](https://www.npmjs.com/) (bundled with Node.js)
|
|
|
|
### **Steps**
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone http://git.wdipl.com/Siddhesh.More/tanami-admin-panel.git
|
|
```
|
|
2. Navigate to the project directory:
|
|
```bash
|
|
cd tanami-admin-panel
|
|
```
|
|
3. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
---
|
|
|
|
## **Usage**
|
|
|
|
### **Development Mode**
|
|
1. Start the development server:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
2. Open your browser and navigate to:
|
|
```
|
|
http://localhost:5173/
|
|
```
|
|
|
|
### **Production Mode**
|
|
1. Install [PM2](https://pm2.keymetrics.io/) globally for process management:
|
|
```bash
|
|
npm install pm2 -g
|
|
```
|
|
|
|
2. Build the application (if applicable):
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
3. Serve the application using PM2:
|
|
```bash
|
|
pm2 serve ./dist <port_number> --spa --name=<application_name>
|
|
```
|
|
Replace:
|
|
- `./dist` with your build directory.
|
|
- `<port_number>` with the desired port (e.g., `3000`).
|
|
- `<application_name>` with the name of your application.
|
|
|
|
4. Save the PM2 process list and enable startup on system reboot:
|
|
```bash
|
|
pm2 save
|
|
pm2 startup
|
|
```
|
|
|
|
---
|
|
|
|
## **Environment Variables**
|
|
|
|
Create a `.env` file in the root directory based on the structure of [`.env.example`](.env.example).
|
|
|
|
---
|
|
|
|
## **Scripts**
|
|
|
|
| Script | Description |
|
|
|---------------------|-------------------------------------------------------------|
|
|
| `npm run dev` | Starts the app in development mode with `Vite` server. |
|
|
| `npm run build` | Builds the app for production. |
|
|
| `npm run lint` | Runs ESLint to check for code quality issues. |
|
|
| `npm run preview` | Previews the production build locally. |
|
|
|
|
---
|
|
|
|
## **License**
|
|
|
|
This project is licensed under the [MIT License](LICENSE).
|
|
|