AplinkosMinisterija/biip-tools

Vidinio naudojimo įrankiai

BĮIP Tools

This repository contains the source code and documentation for the BĮIP Tools, developed by the Aplinkos Ministerija.

Table of Contents

• About the Project
• Getting Started
  • Installation
  • Usage
• OpenAPI
• Deployment
• Contributing
• License

About the Project

The BĮIP Tools is designed to provide helpful tools and functionalities for other BĮIP projects as an API based project.

Getting Started

To get started with the BĮIP Tools, follow the instructions below.

Installation

1. Clone the repository:

   git clone https://github.com/AplinkosMinisterija/biip-tools.git

2. Install the required dependencies:

   cd biip-tools
   yarn install

Usage

1. Set up the required environment variables. Copy the .env.example file to .env and provide the necessary values for the variables.

2. Start the API server:

   yarn dev

The API will be available at http://localhost:3000/tools.

OpenAPI

OpenAPI documentation is available at http://localhost:3000/tools/openapi/ui

To use autogenerated biip-tools-client library in other projects, run the following command:

yarn add @aplinkosministerija/biip-tools-client

Deployment

Production

To deploy the application to the production environment, create a new GitHub release:

1. Go to the repository's main page on GitHub.
2. Click on the "Releases" tab.
3. Click on the "Create a new release" button.
4. Provide a version number, such as 1.2.3, and other relevant information.
5. Click on the "Publish release" button.

Alternatively, you can run yarn release on your computer, and the GitHub release page will be prefilled.

Staging

The main branch of the repository is automatically deployed to the staging environment. Any changes pushed to the main branch will trigger a new deployment.

Development

To deploy any branch to the development environment use the Deploy to Development GitHub action.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. For more information, see the contribution guidelines.

License

This project is licensed under the MIT License.