You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
83 lines
1.1 KiB
83 lines
1.1 KiB
2 years ago
|
# B2C Backend File
|
||
|
|
|
||
|
|
[](https://gitlab.com/csell-team/b2c/sv-backend-file/commits/master)
|
||
|
|
|
||
|
|
Microservice handles all file logics
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- [Node v8+](https://nodejs.org/en/download/current/) or [Docker](https://www.docker.com/)
|
||
|
|
- [Yarn](https://yarnpkg.com/en/docs/install)
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
Install dependencies:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn
|
||
|
|
```
|
||
|
|
|
||
|
|
Set environment variables:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cp .env.example .env
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running Locally
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running in Production
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn start
|
||
|
|
```
|
||
|
|
|
||
|
|
## Lint
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# lint code with ESLint
|
||
|
|
yarn lint
|
||
|
|
|
||
|
|
# try to fix ESLint errors
|
||
|
|
yarn lint:fix
|
||
|
|
|
||
|
|
# lint and watch for changes
|
||
|
|
yarn lint:watch
|
||
|
|
```
|
||
|
|
|
||
|
|
## Test
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# run all tests with Mocha
|
||
|
|
yarn test
|
||
|
|
|
||
|
|
# run unit tests
|
||
|
|
yarn test:unit
|
||
|
|
|
||
|
|
# run integration tests
|
||
|
|
yarn test:integration
|
||
|
|
|
||
|
|
# run all tests and watch for changes
|
||
|
|
yarn test:watch
|
||
|
|
|
||
|
|
# open nyc test coverage reports
|
||
|
|
yarn coverage
|
||
|
|
```
|
||
|
|
|
||
|
|
## Validate
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# run lint and tests
|
||
|
|
yarn validate
|
||
|
|
```
|
||
|
|
|
||
|
|
## Logs
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# show logs in production
|
||
|
|
pm2 logs
|
||
|
|
```
|