Fixed Income Comparison Tool

A modern web application for comparing different fixed income investments, calculating returns, and making informed investment decisions.

Features

• Calculate returns for various fixed income investments
• Compare multiple investments side by side
• Support for different investment types (CDB, LCI, LCA, etc.)
• Tax calculations and exemptions
• Interactive charts and visualizations
• Responsive and modern UI

Tech Stack

Backend

• FastAPI (Python)
• SQLAlchemy (ORM)
• Alembic (Migrations)
• PostgreSQL (Database)
• Pydantic (Data validation)

Frontend

• React
• TypeScript
• Tailwind CSS
• Radix UI
• React Query
• Recharts

Prerequisites

• Python 3.8+
• Node.js 16+
• PostgreSQL
• Git

Installation

1. Clone the repository:

git clone https://github.com/yourusername/fixed-income-comparison.git
cd fixed-income-comparison

2. Set up the backend:

cd backend
python -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate
pip install -r requirements.txt

3. Set up the database:

# Create a PostgreSQL database
createdb fixed_income_db

# Run migrations
alembic upgrade head

4. Set up the frontend:

cd frontend
npm install

Configuration

1. Create a .env file in the backend directory:

DATABASE_URL=postgresql://user:password@localhost:5432/fixed_income_db
SECRET_KEY=your-secret-key

2. Create a .env file in the frontend directory:

VITE_API_URL=http://localhost:8000

Running the Application

1. Start the backend server:

cd backend
uvicorn app.main:app --reload

2. Start the frontend development server:

cd frontend
npm run dev

The application will be available at:

• Frontend: http://localhost:5173
• Backend API: http://localhost:8000
• API Documentation: http://localhost:8000/docs

Development

Backend Development

• API endpoints are defined in backend/app/api/
• Database models are in backend/app/models/
• Business logic is in backend/app/services/

Frontend Development

• Components are in frontend/src/components/
• Pages are in frontend/src/pages/
• API integration is in frontend/src/api/

Testing

Backend Tests

cd backend
pytest

Frontend Tests

cd frontend
npm test

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

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