sec-webapp

A full stack web application designed to provide company financial information from the SEC public API (EDGAR).

Data Sources

The backend API retrieves data from the following SEC endpoints:

• Company Tickers: https://www.sec.gov/files/company_tickers.json
• Company Submissions: https://data.sec.gov/submissions/CIK{cik}.json
• Company Facts: https://data.sec.gov/api/xbrl/companyfacts/CIK{cik}.json

Docker Installation (Recommended)

1. Clone the repository:

   git clone https://github.com/YOUR_GITHUB_USERNAME/sec-webapp.git

2. Navigate to the project directory:

   cd sec-webapp

3. Ensure Docker and Docker Compose are installed on your system

   • Install Docker Desktop

4. Build and run the application using Docker Compose:

   docker-compose up --build

5. Access the application:

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

Manual Installation

Frontend Setup

1. Navigate to the frontend directory:

   cd sec-fe

2. Ensure Node.js is installed (version 18+ recommended)

   • Install Node.js

3. Install dependencies:

   npm install

4. Start the development server:

   npm run dev

5. Access the frontend at http://localhost:3000

Backend Setup

1. Navigate to the backend directory:

   cd sec-be

2. Ensure Python is installed (version 3.13 required)

   • Install Python

3. Create and activate a virtual environment (recommended):

   python -m venv venv
   source venv/bin/activate  # On Windows use: venv\Scripts\activate

4. Install dependencies:

   pip install -r requirements.txt

5. Start the FastAPI server:

   uvicorn main:app --reload

6. Access the backend at http://localhost:8000

Tech Stack

• Frontend: React + Vite
• Backend: FastAPI (Python)
• Containerization: Docker

Development

• The frontend development server includes hot-reloading
• The backend server will automatically reload when changes are detected
• API documentation is available at http://localhost:8000/docs

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request