https://github.com/poorlydefinedbehaviour/gooddoggy

rest api for learning purposes
https://github.com/poorlydefinedbehaviour/gooddoggy

Last synced: 14 days ago
JSON representation

rest api for learning purposes

• Host: GitHub
• URL: https://github.com/poorlydefinedbehaviour/gooddoggy
• Owner: PoorlyDefinedBehaviour
• Created: 2019-08-11T17:41:29.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T05:52:17.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T22:17:27.939Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 255 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# About

Rest api for learning purposes.

# Installation

```sh

git clone https://github.com/PoorlyDefinedBehaviour/gooddoggy

```

# Usage

## Install dependencies

```sh

run 'npm i' or 'yarn'

```

## Running

This project uses docker and docker compose.

```sh

run 'docker-compose up' to start

```

# FAQ

## 'docker-compose up' is not recognized as a command.

Install docker and docker-compose.

# Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

# License

[MIT](https://choosealicense.com/licenses/mit/)