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

https://github.com/vinicamposdev/micro-catalog-old


https://github.com/vinicamposdev/micro-catalog-old

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

        

# catalog-microservice

This application is generated using [LoopBack 4 CLI](https://loopback.io/doc/en/lb4/Command-line-interface.html) with the
[initial project layout](https://loopback.io/doc/en/lb4/Loopback-application-layout.html).

## Install dependencies

By default, dependencies were installed when this application was generated.
Whenever dependencies in `package.json` are changed, run the following command:

```sh
yarn install
```

## Run the application

```sh
yarn start
```

You can also run `node .` to skip the build step.

Open http://127.0.0.1:3000 in your browser.

## Rebuild the project

To incrementally build the project:

```sh
yarn run build
```

To force a full build by cleaning up cached artifacts:

```sh
yarn run rebuild
```

## Fix code style and formatting issues

```sh
yarn run lint
```

To automatically fix such issues:

```sh
yarn run lint:fix
```

## Other useful commands

- `yarn run migrate`: Migrate database schemas for models
- `yarn run openapi-spec`: Generate OpenAPI spec into a file
- `yarn run docker:build`: Build a Docker image for this application
- `yarn run docker:run`: Run this application inside a Docker container

## Tests

```sh
yarn test
```

## Docker Quickstart

If it was the first time running the container. Just run:

```sh
rm -rf node_modules package-lock.json
docker network create rabbitmq_micro-catalog
chmod +x .docker/entrypoint.sh
chmod +x .docker/
docker-compose up -d --build
```

For the rest of the times
```sh
docker-compose up -d
```

If it's needed to shutdown the container, run:

```sh
docker-compose down
```

## What's next

Please check out [LoopBack 4 documentation](https://loopback.io/doc/en/lb4/) to
understand how you can continue to add features to this application.

[![LoopBack](https://github.com/loopbackio/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)[email protected])](http://loopback.io/)