GridexX / linguagen

A backend that generate random words and their traductions

Home Page:https://linguagen.gridexx.fr

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

LinguaGen

An API to generate a random word and translate them

ci api stars license

Setup

Follow these steps to set up and run the project.

Prerequisites

  • Node.js installed
  • NPM (Node Package Manager) installed

Installation

  1. Clone the repository:
git clone https://github.com/GridexX/linguagen.git
  1. Navigate to the project directory:
cd linguagen
  1. Install dependencies:
npm install
  1. Set up Google Cloud Translation API: Set-up a project and enable the translation API. Create an API Key for the project.

Configuration

Create a .env file in the root of the project and add the following:

RANDOM_WORD_API_URL=https://random-word-api.herokuapp.com/word?lang=en
PROJECT_ID=your-project-id
API_KEY=your-api-key

Replace your-project-id and your-api-key with your Google Cloud project ID and API key.

Running the Project

Start the project:

npm start

Visit localhost:3000 in your browser.

Usage

curl http://localhost:3000

License

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

Author

Made during Christmas 2023 🎄 by a BMX 🚲 rider.

About

A backend that generate random words and their traductions

https://linguagen.gridexx.fr

License:MIT License


Languages

Language:TypeScript 91.4%Language:JavaScript 5.0%Language:Dockerfile 3.5%