Skip to content
/ zitwit Public

I'll start with a Twitter cron, but I'll take it further.

Notifications You must be signed in to change notification settings

devkan/zitwit

Repository files navigation

Zitwit: Share Your Updates with the World

Welcome to Zitwit, a microblogging platform designed for developers and tech enthusiasts to share short updates, tips, and news in the tech world. Zitwit allows users to easily post updates and integrate them with social media platforms like Twitter and Instagram, making it easier to spread your word across multiple channels.

Technology Stack

Zitwit leverages modern web development technologies to offer a seamless and efficient user experience:

  • React: For building a dynamic and responsive user interface.
  • Vite: A fast build tool that significantly improves the development experience.
  • TypeScript: Ensuring type safety and enhancing the development workflow.
  • SWC: For super-fast TypeScript transformation and optimization.

React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

  • Configure the top-level parserOptions property like this:
export default {
  // other rules...
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    project: ['./tsconfig.json', './tsconfig.node.json'],
    tsconfigRootDir: __dirname,
  },
}
  • Replace plugin:@typescript-eslint/recommended to plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked
  • Optionally add plugin:@typescript-eslint/stylistic-type-checked
  • Install eslint-plugin-react and add plugin:react/recommended & plugin:react/jsx-runtime to the extends list

Getting Started

Follow these steps to get Zitwit running on your local machine:

  1. Clone the Repository:

    git clone https://github.com/devkan/zitwit.git
    cd zitwit
  2. Install Dependencies:

    npm install
  3. Run the Development Server:

    npm run dev

    Visit http://localhost:5173 to view the application in action.

Contributing

Zitwit is an open-source project, and contributions are warmly welcomed. You can contribute in several ways:

  • Bug Reporting: Use the issue tracker to report any bugs you find.
  • Feature Suggestions: Feel free to suggest new features or improvements.
  • Code Contributions: Submit a Pull Request to contribute directly with code changes.

Please refer to CONTRIBUTING.md for more information on how to contribute to the project.

License

This project is open-sourced under the MIT License.

Contact

If you have any questions or suggestions about Zitwit, feel free to use the issue tracker.

About

I'll start with a Twitter cron, but I'll take it further.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages