Words Project

Overview

The Words Project is a web application built with TypeScript and React. It leverages the Next.js framework and includes several popular libraries such as Chakra UI for UI components, Firebase for backend services, and React Hook Form for form management. The purpose of this project is to help people memorize vocabulary in different languages.

Screens

Login Page

Signup Page

Home Page

Add Word Page

Installation and Setup

To get started with the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/caiquedebrito/words-project.git
   cd words-project

2. Install the dependencies:

   npm install

3. Run the development server:

   npm run dev

4. Open your browser and navigate to http://localhost:3000 to see the application in action.

Scripts

The following scripts are available in the project:

• npm run dev: Runs the development server.
• npm run build: Builds the application for production.
• npm run start: Starts the production server.
• npm run lint: Runs the linter to check code quality.

Dependencies

The project uses the following main dependencies:

• @chakra-ui/react: UI components library.
• firebase: Firebase services for backend.
• next: Next.js framework.
• react: React library.
• react-hook-form: Form management library.

Development Dependencies

• typescript: TypeScript language support.
• firebase-tools: Firebase CLI tools.

Usage

• User Authentication
• Word's Menagment

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.