Skip to content
This repository was archived by the owner on Jun 22, 2023. It is now read-only.

README.md

Latest commit

 

History

History
115 lines (90 loc) · 4.38 KB

README.md

File metadata and controls

115 lines (90 loc) · 4.38 KB

Translatify API

Translatify is a MultiTenant based Web Application used to help organize, manage and translate all kind of Texts in different languages.


Logo of the organization SWEG

Translatify API

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage

About The Project

Hosted on Amazon Web Services this software offers a multiplatform backend where an organization can add and translate texts in different languages and an API library to allow to retrive the texts in the desired language and use them on their own Websites and Web Applications as pleased.

API

This repo contains the main software with the API functions that run under AWS. It features all the lambdas functions available. The data is stored in dynamoDB. Cognito is used to secure all the functions that are used by the translating process for the organization, while the other funcions to retrive the texts are public. A Postman json is included with the list of all the different functions available.

For more examples, please refer to the Documentation, only available in italian at the moment

Built With

  • AWS
  • React
  • Node
  • TS

(back to top)

Getting Started

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

Prerequisites

Make sure you have the latest version of npm.

  • npm 
    npm install npm@latest -g

Installation

  1. Download and install AWS CLI

  2. Clone the repo

    git clone https://github.com/SWEG-Software-Engineering-Group/API.git

  3. Install NPM packages

    npm install

  4. Install serverless framework package

    npm i -g serverless

  5. Configure AWS CLI with your credentials as explained here

  6. Run serverless

    cd API-Progetto
serverless start

(back to top)

Usage

Import SWEG.postman_environment.json and translatify_postman.json into Postman. Go under environment variables and change the Authentication Token with the one you get afer logging in inside the platform as Admin. Then you can change the other parameters used in the calls on your need.

(back to top)