Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.idea/
.DS_Store
.vscode/*
!.vscode/extensions.json
node_modules/
Expand Down
2 changes: 1 addition & 1 deletion compose.override.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ services:
context: .
dockerfile: frontend/Dockerfile
args:
- VITE_API_URL=http://localhost:8000
- VITE_API_URL=
- NODE_ENV=development

playwright:
Expand Down
66 changes: 66 additions & 0 deletions documentation/Proposals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Proposal 1
## Project Title
CiteSync: Academic Knowledge and Citation Management API

## Introduction
Graduate students and researchers often struggle with organizing complex literature references and adhering to strict academic formatting rules, such as the APA 7th edition. The objective of this project is to develop a centralized knowledge management system that stores academic metadata, parses reading notes, and automatically generates properly formatted bibliographies. The expected benefit is a significant reduction in manual formatting errors and a highly streamlined workflow for academic writing and research tracking.

## Technologies and Tools Used
The project will be built using the FastAPI full-stack template:

- **Backend**: Python and FastAPI to process metadata and handle the formatting logic.

- **Frontend**: React for a clean UI where users can input literature details and tag notes.

- **Database**: PostgreSQL to map complex many-to-many relationships between authors, publications, and user notes.

- **Formatting Engine**: Python libraries (such as citeproc-py) integrated with the API to dynamically render citations in standard academic formats.

## Final Outcome
The deliverable will be a full-stack web application featuring a robust literature repository. Users will be able to input, search, and categorize academic papers. The system will feature an export module that compiles selected references into a dynamically generated, perfectly formatted bibliography, meeting the strict requirements of modern academic research.

# Proposal 2
## Project Title
FinLaw: Automated Financial Compliance Document Workflow System

## Introduction
The financial sector requires rigorous adherence to legal and regulatory compliance, which often involves the manual review of extensive documentation. The problem being addressed is the inefficiency and high risk of human error associated with manual compliance checks. The objective of this project is to develop an automated workflow system that manages, tracks, and flags financial documents for legal compliance review. The expected benefit is a significant reduction in administrative overhead, improved accuracy in identifying compliance risks, and a streamlined auditing process for financial institutions.

## Technologies and Tools Used
This project will be built upon the provided FastAPI full-stack template.

- **Backend**: Python and FastAPI for high-performance, asynchronous API endpoints.

- **Frontend**: React (integrated within the template) to build an interactive administrative dashboard.

- **Database**: PostgreSQL for robust, relational data storage of document metadata and compliance logs, replacing lightweight solutions like SQLite3 for production readiness.

- **ORM & Data Validation**: SQLModel/SQLAlchemy and Pydantic for strict data typing and database interactions.

- **Containerization**: Docker and Docker Compose for consistent deployment and environment management.

## Final Outcome
The final deliverable will be a deployed full-stack web application featuring a user-friendly dashboard. The system will allow users to upload document records, track their compliance status through a Kanban-style workflow, and generate automated compliance reports. It will successfully meet the project objectives by providing a centralized, secure, and efficient platform for managing financial legal documentation workflows.

# Proposal 3
## Project Title
ForeXchange: Full-Stack Real-Time Currency Conversion and Remittance Dashboard

## Introduction
While basic money exchange applications handle simple conversions, real-world remittance requires scalable architecture, real-time rate tracking, and secure transaction management. This project addresses the lack of accessible, full-stack solutions for tracking cross-border currency exchanges efficiently. The objective is to engineer a robust currency exchange platform that handles user authentication, live rate simulations, and secure transaction histories. The expected impact is providing users with a transparent, fast, and reliable tool for managing foreign exchange operations and remittance planning.

## Technologies and Tools Used
The solution will leverage the modern Python web ecosystem via the FastAPI template.

- **Core Backend**: Python 3 and FastAPI to handle RESTful API requests and complex currency conversion logic.

- **Frontend**: React for a responsive, single-page application (SPA) interface.

- **Database Management**: PostgreSQL to handle transactional data securely, migrating away from flat-file or local databases to a true client-server architecture.

- **Authentication**: OAuth2 with password flow and JWT tokens (built into the FastAPI template) for secure user session management.

- **Deployment**: Dockerized microservices orchestrated with Traefik for reverse proxy and load balancing.

## Final Outcome
The expected outcome is a fully functional web-based prototype of a currency exchange platform. It will include a secure login system, an interactive dashboard displaying currency trends, and a module for executing and recording simulated money exchange transactions. This will meet the user requirements for a secure, database-driven financial application built on modern software engineering principles.
23 changes: 20 additions & 3 deletions frontend/nginx-backend-not-found.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
resolver 127.0.0.11 ipv6=off;

location /api {
return 404;
set $backend http://backend:8000;
proxy_pass $backend;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
location /docs {
return 404;
set $backend http://backend:8000;
proxy_pass $backend;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
location /redoc {
return 404;
set $backend http://backend:8000;
proxy_pass $backend;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
Loading