/tweetcaster

A simple UI to post on Farcaster and Twitter

Primary LanguageTypeScriptMIT LicenseMIT

Tweetcaster (In development)

A simple UI to cast on Farcaster and Tweet on Twitter in one go.

Development

To start the project locally, run:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Requirements

  • Node.js >= 12.22.0
  • Yarn 1 (Classic)

Directory Structure

  • .github — GitHub configuration including the CI workflow.
  • public — Static assets such as robots.txt, images, and favicon.
  • src — Application source code, including pages, components, styles.

Scripts

  • yarn dev — Starts the application in development mode at http://localhost:3000.
  • yarn build — Creates an optimized production build of your application.
  • yarn start — Starts the application in production mode.
  • yarn type-check — Validate code using TypeScript compiler.
  • yarn lint — Runs ESLint for all files in the src directory.
  • yarn format — Runs Prettier for all files in the src directory.
  • yarn commit — Run commitizen. Alternative to git commit.

Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the @ prefix.

import { Button } from '@/components/Button';

// To import images or other files from the public folder
import avatar from '@/public/avatar.png';

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.