Number to Word - T9

A full-stack aplication that simulates T9 keyboard ⌨️

Description

The project aims to simulate a T9 keyboard, where the frontend was developed in React + Typescript and the backend with Nestjs (Node + Typescript).

The project also works on mobile 📱, accessing the local url:

🔧 Prerequisite

To bring up the application, you MUST first:

• Clone the repository
  • git clone git@github.com:wenderpmachado/number-to-word-t9.git
• Install the dependencies
  • yarn install or npm install
• Set the environment variables
  • Renaming the .env.example file to .env
  • Fill in the secret information

🚀 Running the WEB

To start the web application, run the following code:

# development
$ cd web
$ yarn start

🚀 Running the API

To start the API, run the following code:

# development
$ cd api

# running mongodb database
$ docker compose -f "api\docker-compose.yml" up -d --build

# running the server
$ yarn start:dev

After the database and the server are running, make a request to populate the database with the most used words in English. You can check it on the API documentation url:

http://localhost:4000/api

✔️ Test

The project has implemented unit tests:

# unit tests
$ yarn test

FYI: Currently just the core algorithm was well tested

---

Roadmap 🔭

API

• Increase the unit test coverage
• Add CI/CD with GitHub Actions
• Add Node start up on docker-compose
• Add migration concept to populate the database
• Make a smart search depending on what the user selected previously

Web

• Add ESlint/Prettier on Web
• Implement tests
• Implement redux to store the messages

green background has been implemented

👋 Stay in touch

• Author - Wender Machado