https://github.com/crane-cloud/database-api

https://github.com/crane-cloud/database-api

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/crane-cloud/database-api
• Owner: crane-cloud
• Created: 2024-02-13T10:43:00.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T21:02:30.000Z (about 2 years ago)
• Last Synced: 2024-05-22T21:59:24.307Z (about 2 years ago)
• Language: Python
• Size: 166 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Database API

[![Coverage Status](https://coveralls.io/repos/github/crane-cloud/database-api/badge.svg?branch=develop)](https://coveralls.io/github/crane-cloud/database-api?branch=develop)

[![Prod](https://github.com/crane-cloud/database-api/actions/workflows/prod.yml/badge.svg)](https://github.com/crane-cloud/database-api/actions/workflows/prod.yml)

[![staging](https://github.com/crane-cloud/database-api/actions/workflows/staging.yaml/badge.svg)](https://github.com/crane-cloud/database-api/actions/workflows/staging.yaml)

The database API offers a convenient and efficient way to create MySQL and PostgreSQL databases for users on the Crane Cloud platform

# Project Setup

Follow these steps to have a local running copy of the app.

Clone The Repo

```

git clone https://github.com/crane-cloud/database-api.git

```

# Running application with Docker

`make` is a build automation tool that is used to manage the build process of a software project.

In the project directory, running `make` shows you a list of commands to use.

Run `make start` to start the application and required services.

Run `make connect-to-container` to connect to the FastAPI application container.

Run `make test` to run tests in the application