Backend services for Wordigo, handling data processing and user management, using Azure Translate for translations.
MIT License
Welcome! This document comprehensively explains the setup and usage of the Wordigo API. The Wordigo API is a backend service designed to manage dictionaries, words, translations, and user interactions.
Before starting, make sure the following are installed:
Clone the repository:
git clone https://github.com/wordigo/api.wordigo.app.git
cd api.wordigo.app
Install dependencies:
pnpm install
In the root directory, copy the .env.example
file to create a .env
file and fill in the necessary environment variables:
cp .env.example .env
Then edit the .env
file with your own values.
To start the server in development mode:
pnpm run dev
To build the application for production:
pnpm run build
To start the server in production mode:
pnpm start
While the server is running, you can visit the Swagger UI at this address to interact with the API:
http://localhost:4000/docs
To run automated tests:
pnpm test
Thank you for your contributions! We appreciate all the contributions from the community.
For questions or feedback, please reach out to us at [email protected].
This project is licensed under the MIT License - see the LICENSE file for details.