Duplica Web Documentation

Status

Table of contents

• Dependencies
• Environment configuration
• Install
• Run
• Test
• Deploy
• Structure of the application
• Deploying to prod

Follow the next steps to Install, Run, Test and Deploy the API.

Dependencies

• React

Environment configuration

Create .env file in your local environment and add the follow attributes

API_BASE_URL=http://localhost:3000

Install

npm i

Run

npm start

Tests

Runs all tests like in the CI environment

npm test

Runs all tests like in the CI environment and keep watching

npm run test:auto

Coverage tests

npm run coverage

Lint tests

npm run lint

Deploy

It's completely automated and will deploy to staging as soon as the code is merged in the master branch

Structure of the application

.
├── .github                 # Github templates
├── .semaphore              # CI config files
├── src                     # Source files
    ├── api                 # API config files
    ├── assets              # Static files and images
    ├── components          # All components
    ├── i18n                # Translation files
    ├── index.js            # Main js file of the application
├── tests                   # Supporting test files
├── index.html              # Main html file of the application
└── LICENSE                 # Apache-2.0 License
├── package.json            # NPM configuration file
└── README.md               # This file

Deploying to prod

After staging deploy, in semaphore CI just push the pipeline to prod