Firmco Online Portfolio Management Admin App

React, Tailwind CSS & Firebase

This repository contains the code for Firmco oniline portfolio management admin app built with React on the frontend, Tailwind CSS for styling, and Firebase for authentication, database management, and stock API integration. It controls and oversees every aspect of the financial transactions and user management within the Firmco platform.

️ Tech Stack

• Frontend: React, Tailwind CSS
• Backend: Firebase (Authentication, Database, Cloud Functions)
• Additional: Stock API (integration details to be specified)

Features

• Authentication:

  • Secure login and registration with Firebase authentication.
  • Password reset functionality.

• Database Management:

  • Store user, product, and transaction data in Firebase Firestore.

• Responsive Design:

  • Mobile-friendly layout for easy access on all devices.
  • Customizable Tailwind CSS styles for a modern look.

• Product Management:

  • Add, edit, and delete bonds, and fixed-term deposits. Add and edit stock shares owned by users.

• User Management:

  • Add, update, and delete user profile information, bank information, kyc information etc.
  • Perform transactions on behalf of users.
  • View user transaction history.
  • Send notifications to users.
  • Chat with users in real-time.

• App Settings:

  • Update app metadata (title, description).
  • Change favicon and logo.
  • Manage visible menus and pages for users.
  • Set password policy (weak/strong).

• Admin Management:

  • Add and delete admins.

• Activity Monitoring:

  • Track user login/logout activity.
  • View user transaction history through notifications.

• Stock API Integration:

  • Fetch real-time stock data for users' stock shares.

Getting Started

1. Prerequisites:
   • Node.js and npm (or yarn) installed on your machine.
   • A Firebase project with configured authentication and database.
   • A stock API key (details on integration to be provided).
2. Clone the Repository:

   git clone https://github.com/your-username/financial-admin-app.git

3. Install Dependencies:

   cd financial-admin-app
   npm install (or yarn install)

4. Configure Firebase:
   • Create a .env.local file in the project root.
   • Add your Firebase project configuration details to the .env.local file (refer to Firebase documentation for details).
5. Configure Stock API:
   • Implement stock API integration based on the specific API provider's documentation.
   • Store API key securely (avoid committing it to version control).
6. Start the Development Server:

   npm start (or yarn start)

   This will start the development server at http://localhost:3000 by default.

Deployment

Instructions for deploying the app to production will depend on your chosen hosting platform. Firebase offers hosting capabilities, or you can choose a different provider. Refer to the platform's documentation for deployment instructions.

Contributing

Bug reports and pull requests are welcome! Please follow standard Git practices and create issues for any bugs you encounter.

License

This project is licensed under the MIT License (see LICENSE file for details).

Note: This is a basic README documentation. You may need to add further details specific to your project, such as:

• Specific instructions for configuring the stock API.
• Screenshots or documentation for the admin dashboard interface.
• Any additional features or functionalities not mentioned here.

Author

Lilian Okeke - Firmco Admin App