https://github.com/vinicamposdev/micro-catalog
https://github.com/vinicamposdev/micro-catalog
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vinicamposdev/micro-catalog
- Owner: vinicamposdev
- Created: 2022-01-24T15:07:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-24T21:29:21.000Z (over 3 years ago)
- Last Synced: 2025-01-21T11:21:50.128Z (5 months ago)
- Language: TypeScript
- Size: 145 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# micro-catalog
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
npm install
```
To only install resolved dependencies in `package-lock.json`:
```sh
npm ci
```
## Run the application
```sh
npm 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
npm run build
```
To force a full build by cleaning up cached artifacts:
```sh
npm run rebuild
```
# Use docker on developer environment
First you need install [docker install](https://docs.docker.com/engine/install/) and [docker compose](https://docs.docker.com/compose/install/)
```sh
chmod a+x .docker/entrypoint.sh
npm run container:up
```
## Fix code style and formatting issues
```sh
npm run lint
```
To automatically fix such issues:
```sh
npm run lint:fix
```
## Other useful commands
- `npm run migrate`: Migrate database schemas for models
- `npm run openapi-spec`: Generate OpenAPI spec into a file
- `npm run docker:build`: Build a Docker image for this application
- `npm run docker:run`: Run this application inside a Docker container
## Tests
```sh
npm test
```
## Environment
Create a .env file based on the variables described on the given [.env.example file](.env.example)
## 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.
[[email protected])](http://loopback.io/)