Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wordigo/api.wordigo.app
Backend services for Wordigo, handling data processing and user management, using Azure Translate for translations.
https://github.com/wordigo/api.wordigo.app
api azure-translator docker docker-compose fastify jsonschema postgresql prisma railway react-email s3 wordigo wordigo-api
Last synced: 7 days ago
JSON representation
Backend services for Wordigo, handling data processing and user management, using Azure Translate for translations.
- Host: GitHub
- URL: https://github.com/wordigo/api.wordigo.app
- Owner: wordigo
- License: mit
- Created: 2023-07-22T20:45:52.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2024-05-19T17:32:32.000Z (6 months ago)
- Last Synced: 2024-10-31T09:50:23.154Z (14 days ago)
- Topics: api, azure-translator, docker, docker-compose, fastify, jsonschema, postgresql, prisma, railway, react-email, s3, wordigo, wordigo-api
- Language: TypeScript
- Homepage: https://www.wordigo.app/
- Size: 8.3 MB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wordigo API
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.
## Features
- **User Authentication**: Secure login and registration functionality.
- **Dictionary Management**: Create, update, delete, and retrieve dictionaries.
- **Word Management**: Add, update, and delete words within dictionaries.
- **Translation Services**: Use external APIs to translate words.
- **Dashboard Statistics**: Provides general statistics and word interaction data.
- **Swagger Documentation**: Automatically generated API documentation with Swagger.
## Prerequisites
Before starting, make sure the following are installed:
- Node.js (v14 or newer)
- pnpm
- Git
## Installation
Clone the repository:
```bash
git clone https://github.com/wordigo/api.wordigo.app.git
cd api.wordigo.app
```
Install dependencies:
```bash
pnpm install
```
## Configuration
In the root directory, copy the `.env.example` file to create a `.env` file and fill in the necessary environment variables:
```bash
cp .env.example .env
```
Then edit the `.env` file with your own values.
## Running the Application
To start the server in development mode:
```bash
pnpm run dev
```
To build the application for production:
```bash
pnpm run build
```
To start the server in production mode:
```bash
pnpm start
```
## API Documentation
While the server is running, you can visit the Swagger UI at this address to interact with the API:
```
http://localhost:4000/docs
```
## Testing
To run automated tests:
```bash
pnpm test
```
## 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]](mailto:[email protected]).
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/wordigo/api.wordigo.app/blob/main/LICENSE) file for details.