https://github.com/aplinkosministerija/biip-admin-api

BĮIP Administravimo aplinkos API
https://github.com/aplinkosministerija/biip-admin-api

admin-api api biip-admin

Last synced: 7 days ago
JSON representation

BĮIP Administravimo aplinkos API

• Host: GitHub
• URL: https://github.com/aplinkosministerija/biip-admin-api
• Owner: AplinkosMinisterija
• License: mit
• Created: 2023-11-14T08:36:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-27T18:57:41.000Z (11 months ago)
• Last Synced: 2024-11-12T07:31:40.664Z (2 months ago)
• Topics: admin-api, api, biip-admin
• Language: TypeScript
• Homepage: https://admin.biip.lt
• Size: 134 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BĮIP Admin API

[![License](https://img.shields.io/github/license/AplinkosMinisterija/biip-admin-api)](https://github.com/AplinkosMinisterija/biip-admin-api/blob/main/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/AplinkosMinisterija/biip-admin-api)](https://github.com/AplinkosMinisterija/biip-admin-api/issues)

[![GitHub stars](https://img.shields.io/github/stars/AplinkosMinisterija/biip-admin-api)](https://github.com/AplinkosMinisterija/biip-admin-api/stargazers)

This repository contains the source code and documentation for the BĮIP Admin API, developed by the Aplinkos

Ministerija.

## Table of Contents

- [About the Project](#about-the-project)

- [Getting Started](#getting-started)

  - [Installation](#installation)

  - [Usage](#usage)

- [OpenAPI](#openapi)

- [Deployment](#deployment)

- [Contributing](#contributing)

- [License](#license)

## About the Project

The BĮIP Admin API is designed to provide information and functionalities related to user management.

## Getting Started

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

### Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/AplinkosMinisterija/biip-admin-api.git

   ```

2. Install the required dependencies:

   ```bash

   cd biip-admin-api

   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:

   ```bash

   yarn dc:up

   yarn dev

   ```

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

## 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.

### 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](./CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](./LICENSE).