Skip to content

JohnAdib/oops-terminal

Repository files navigation

Oops Terminal

oops-terminal is a playful terminal UI component for React and non-React projects. It provides a simple, customisable way to create terminal-like UIs for fun or functional purposes.


Features

  • Create a terminal-style UI for your projects.
  • Customisable header, content, and type features.
  • Works in both React and non-React environments.
  • Lighthearted and entertaining terminal effects.

Installation

To install the package, use npm:

npm install oops-terminal

Usage

In a React Project

import React from 'react';
import { oopsTerminal } from 'oops-terminal';

const App = () => {
  React.useEffect(() => {
    oopsTerminal();
  }, []);

  return <div id="oops-terminal"></div>;
};

export default App;

Roadmap

  • Add more customisation options.
  • Support for animations and themes.
  • Build-in sample error messages and playful responses.

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a feature branch: git checkout -b feature/your-feature.
  3. Commit your changes: git commit -m 'Add your feature'.
  4. Push to the branch: git push origin feature/your-feature.
  5. Open a pull request.

License

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

About

A simple terminal UI component for React!

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •