Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 2.52 KB

README.md

File metadata and controls

79 lines (53 loc) · 2.52 KB
Raw

Wordigo Frontend Monorepo

About

Wordigo is a comprehensive browser extension project designed to enhance vocabulary learning on the web. It allows users to translate and add words to a personal dictionary directly while browsing.

Technologies

  • Frontend: React, Next.js, TailwindCSS, Shadcn, Redux, Next-SEO, Next-Auth
  • Monorepo Management: TurboRepo

Getting Started

Prerequisites

  • Node.js
  • Yarn

Environment Variables

Copy .env.example to .env and fill in the necessary variables to configure the application environment.

Folder Structure

wordigo/
├── apps/
│   └── next/                          # Main web application built with Next.js.
├── packages/
│   ├── ui/                            # Reusable UI components built with Shadcn and TailwindCSS.
│   ├── config/                        # Shared configuration files and utilities.
│   ├── tsconfig/                      # Shared TypeScript configuration settings.
│   └── common/                        # Shared utilities and common code.
├── .env.example                       # Example environment variables file.
├── .gitignore                         # Specifies intentionally untracked files to ignore in Git.
├── LICENSE                            # License file for the project.
├── package.json                       # Project metadata and dependencies.
├── yarn.lock                          # Yarn lock file to lock down versions of package dependencies.
├── README.md                          # Project documentation and setup guide.
├── .prettierrc.json                   # Prettier configuration file for code formatting.
└── turbo.json                         # TurboRepo configuration for managing the monorepo.

Installation

  1. Clone the repository:
git clone https://github.com/your-repository-url
  1. Install dependencies:
yarn install
  1. Run the development server:
yarn dev

Contributors

Thank you for your contributions! We appreciate all the contributions from the community.

Contact

For questions or feedback, please reach out to us at [email protected].

License

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