Update README.md

2024-12-20 09:36:28 +00:00
parent 5b2efcd292
commit b4d28387fa
1 changed files with 97 additions and 7 deletions
--- a/README.md
+++ b/README.md
@@ -1,10 +1,100 @@
-# React + Vite
+# **Tanami Capital**

-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+**Tanami** is a cutting-edge fintech platform designed to streamline investment opportunities for users in the Gulf region. It features two main components:

-Currently, two official plugins are available:
+- **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.  

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-# rubix-admin-panel
-# tanami-admin-panel
+---
+
+## **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-Backend-Final
+	```
+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:3000
+	```
+
+### **Production Mode**
+1. Install [PM2](https://pm2.keymetrics.io/) globally for process management:  
+	```bash
+	npm install pm2 -g
+	```
+2. Start the production server:  
+	```bash
+	npm start
+	```
+
+---
+
+## **Environment Variables**
+
+Create a `.env` file in the root directory based on the structure of [`.env.example`](.env.example). 
+
+---
+
+## **Scripts**
+
+| Script             | Description                                                 |
+|---------------------|-------------------------------------------------------------|
+| `npm start`         | Starts the app in production mode using PM2.                |
+| `npm run dev`       | Starts the app in development mode with `nodemon`.          |
+| `npm run test`      | Starts the app in test mode with `nodemon`.                 |
+| `npm run lint`      | Runs ESLint to check for code quality issues.               |
+| `npm run lint:fix`  | Fixes fixable issues detected by ESLint.                    |
+| `npm run prettier`  | Checks code formatting using Prettier.                      |
+| `npm run prettier:fix` | Formats code files according to Prettier rules.          |
+| `npm run prepare`   | Prepares Husky for managing Git hooks.                      |
+
+---
+
+## **License**
+
+This project is licensed under the [MIT License](LICENSE).