3.0.3 • Published 1 year ago

@conto/tars v3.0.3

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

Here's the updated README with the professional and concise tone for freelancers:


TARS Security Wrapper 🛡️

TARS: A robust security wrapper that protects freelance projects through advanced station verification, ensuring timely client payments.


🌟 Key Features

  • Real-time station verification for all your projects
  • Multi-platform support: Works with any JS, React, or general JavaScript project
  • Effortless setup with zero config
  • TypeScript support out of the box
  • Elegant error handling with modern overlays
  • Full access to a secure, interactive dashboard for station management

🚀 Installation

npm install @conto/tars

⚡ Quick Start

Get your credentials:

  • TARS_STATION_ID (UUID format)
  • TARS_LAZARUS_KEY (Format: LZRS-XXXXX-XXXXX-XXX)

Add environment variables to your .env:

TARS_STATION_ID=your-station-id
TARS_LAZARUS_KEY=your-lazarus-key

Wrap your root layout:

import { TARS } from '@conto/tars';

function RootLayout({ children }) {
  return children;
}

export default TARS(RootLayout);

🛠️ T.A.R.S Command Center

Manage and monitor your T.A.R.S stations and system logs in a streamlined dashboard. Track station health, monitor activity, and ensure everything runs smoothly with ease.


Dashboard Overview:

  • Total Stations: 4 (2 operational + 2 protected)
  • Operational Status: 100% (2 stations fully functional)
  • Recent Activity: 1 activity in the last hour
  • System Logs: Real-time logs for station activity and events

For more detailed insights, contact me for additional details.


🔒 Security Features

  • Real-time station status verification
  • Secure credential validation
  • Production environment protection
  • Development mode warnings
  • Invalid setup detection
  • Automatic error handling

⚙️ Configuration

  • Handles environment detection (development/production)
  • Manages credential validation and API communication
  • Provides clean error displays and loading states

🎨 Error Handling

  • Modern, non-intrusive error overlays
  • Development warnings and error messages
  • Station status updates in real-time

🎯 Best Practices

  • Use environment variables for credentials
  • Never commit credentials to version control
  • Always place TARS wrapper at the root level of your project
  • Review the development console for helpful warnings

⚠️ Common Issues

  • Missing or incorrect credentials
  • Invalid UUID or Lazarus key format
  • Network connectivity issues
  • Station status errors

🔍 Development Mode

In development mode, you get detailed error messages, visual debugging aids, and real-time validation, making it easier to troubleshoot and ensure everything is working perfectly.


💡 Production Mode

In production, TARS enforces strict validation, blocks error screens, minimizes error details, and optimizes performance for the best security.


🤝 Contact

For access to the code or any inquiries, reach out to me at rudr.me.


🖋️ License

MIT License


3.0.3

1 year ago

3.0.2

1 year ago

3.0.0

1 year ago

2.5.9

1 year ago

2.5.8

1 year ago

2.4.8

1 year ago

2.3.8

1 year ago

2.3.7

1 year ago

2.2.7

1 year ago

2.2.5

1 year ago

2.2.3

1 year ago

2.1.3

1 year ago

2.1.2

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago