Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ralph-souza/catalog_api

This project objective is to create a personal items catalog which includes things such as books, games, videos, etc. It uses Python as backend, docker for encapsulation, and others technologies.
https://github.com/ralph-souza/catalog_api

django django-rest-framework docker docker-compose postgresql python

Last synced: 18 days ago
JSON representation

This project objective is to create a personal items catalog which includes things such as books, games, videos, etc. It uses Python as backend, docker for encapsulation, and others technologies.

Awesome Lists containing this project

README

        

# CATALOG_API

Simple personal items catalog API that provides a CRUD structure for items and loan info registration.

## USAGE

In order to **RUN** this application you must:

Build the image

```
$ docker build -t catalog-image:latest .
```

To **RUN** the container use the following command:

```
$ docker-compose up
```

Then open a second terminal to access the container by running the following command:

```
$ docker exec -it catalog-api bash
```

Once inside the container **RUN** Django model migration command as the example bellow:

```
$ ./manage.py makemigrations
```

```
$ ./manage.py migrate
```

## DATABASE STRUCTURE

![Data Base Diagram](./docs/item_catalog.svg)