balconythoughts readme

A modern, feature-rich React-based portfolio and information hub showcasing various projects, interests, and real-time data feeds. The application features a responsive design with theme customization, comprehensive routing, and a wide range of specialized content sections.

Features

• Dynamic Theming: Three theme options (Dark, Medium, Light) with smooth transitions
• Responsive Layout: Collapsible sidebar with adaptive content layout
• Comprehensive Content Sections:
  • Personal projects and experience
  • Real-time geopolitical rss feeds
  • Information security docs
  • Travel and activity tracking
  • Technical guides
  • Cryptographic tools and resources
• Modern UI Components:
  • Interactive charts and visualizations
  • RSS feed integration
  • Calendar and timeline components
  • Contact and PGP key management

Tech Stack

• Frontend Framework: React 18 with TypeScript
• Styling: Styled Components with theme customization
• Routing: React Router v6
• Icons: React Icons
• Development Tools:
  • Create React App
  • TypeScript
  • ESLint
  • Prettier

Project Structure

balconythoughts-prd/
├── public/               # Static assets and HTML template
│   └── images/           # Image assets
├── src/                  # Source code
│   ├── components/       # Reusable React components
│   │   ├── Layout/       # Layout components
│   │   ├── Sidebar/      # Navigation components
│   │   └── ...           # UI components
│   ├── pages/            # Page components
│   │   ├── Activity/     # Activity tracking pages
│   │   ├── Blogs/        # Blog content pages
│   │   ├── Feeds/        # RSS feeds 
│   │   └── ...           # Other pages
│   ├── styles/           # Global styles and theme
│   ├── App.tsx           # Main application component
│   ├── index.tsx         # Application entry point
│   └── .gitignore        # Files to exclude from GitHub
├── package.json          # Project dependencies
└── package-lock.json     # Dependency lock file

Getting Started

Prerequisites

• Node.js (v14 or higher)
• npm (v6 or higher)

Installation

1. Clone the repository

git clone [repository-url]
cd balconythoughts

2. Install dependencies

npm install

3. Start the development server

npm start

The application will run on http://localhost:3000

Theme Configuration

The application supports three themes:

• Dark Theme: Default theme with dark background and light text
• Medium Theme: Intermediate theme with medium-dark background
• Light Theme: Light theme with white background and dark text

Themes can be toggled through the sidebar interface.

Available Scripts

• npm start - Runs the app in development mode
• npm build - Builds the app for production
• npm test - Launches the test runner
• npm eject - Ejects from Create React App

Security Features

• PGP key management
• Cryptographic tools
• Secure contact forms
• Information security resources

Data Integration

• RSS feed aggregation
• Real-time news updates
• Geopolitical event tracking
• Information security updates

License

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

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.