Skip to content
This repository has been archived by the owner on Jul 2, 2023. It is now read-only.

Commit

Permalink
[+] add : update README
Browse files Browse the repository at this point in the history
  • Loading branch information
aslupin committed Jan 9, 2021
1 parent 6da5019 commit 323f1ff
Showing 1 changed file with 63 additions and 17 deletions.
80 changes: 63 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,78 @@
# carrier-management-service

### Installation - Todo APIs
## Pre-requires 👻

```bash
- Docker
- NPM
- Node (LTS version)

## Installation 🎉

```sh
npm install
```

### Usage
## Building 🔧

```bash
docker-compose up
```sh
npm run build
```

## Starting 🚀

```sh
npm run start:dev # development mode
# or
npm run dev
npm run start:stag # staging mode
# or
npm run build
npm run start
npm run start:prod # production mode
```

### Testing
## Branch 🔥

#### Unit test
- develop : Branch for development
- stag-release-image: Branch for release to GCR: GCR is registry for storing image.
- stag-release: Branch for release to Cloud Run (GCP) (staging environment)

```bash
npm run test
```
## Dependencies 🤖

- [axios](https://ghub.io/axios): Promise based HTTP client for the browser and node.js
- [bcrypt](https://ghub.io/bcrypt): A bcrypt library for NodeJS.
- [config-yaml](https://ghub.io/config-yaml): YAML configuration for NodeJS
- [dotenv](https://ghub.io/dotenv): Loads environment variables from .env file
- [fastify](https://ghub.io/fastify): Fast and low overhead web framework, for Node.js
- [fastify-auth](https://ghub.io/fastify-auth): Run multiple auth functions in Fastify
- [fastify-cors](https://ghub.io/fastify-cors): Fastify CORS
- [fastify-jwt](https://ghub.io/fastify-jwt): JWT utils for Fastify
- [fastify-plugin](https://ghub.io/fastify-plugin): Plugin helper for Fastify
- [mongoose](https://ghub.io/mongoose): Mongoose MongoDB ODM
- [ts-node](https://ghub.io/ts-node): TypeScript execution environment and REPL for node.js, with source map support
- [uuid](https://ghub.io/uuid): RFC4122 (v1, v4, and v5) UUIDs

## Dev Dependencies 👻

- [@babel/core](https://ghub.io/@babel/core): Babel compiler core.
- [@babel/preset-env](https://ghub.io/@babel/preset-env): A Babel preset for each environment.
- [@babel/preset-typescript](https://ghub.io/@babel/preset-typescript): Babel preset for TypeScript.
- [@types/bcrypt](https://ghub.io/@types/bcrypt): TypeScript definitions for bcrypt
- [@types/body-parser](https://ghub.io/@types/body-parser): TypeScript definitions for body-parser
- [@types/config-yaml](https://ghub.io/@types/config-yaml): TypeScript definitions for config-yaml
- [@types/jest](https://ghub.io/@types/jest): TypeScript definitions for Jest
- [@types/mongoose](https://ghub.io/@types/mongoose): TypeScript definitions for Mongoose
- [@types/node](https://ghub.io/@types/node): TypeScript definitions for Node.js
- [@types/uuid](https://ghub.io/@types/uuid): TypeScript definitions for uuid
- [babel-jest](https://ghub.io/babel-jest): Jest plugin to use babel for transformation.
- [jest](https://ghub.io/jest): Delightful JavaScript Testing.
- [mock-express-response](https://ghub.io/mock-express-response): Nodejs library to mock express http response
- [newman](https://ghub.io/newman): Command-line companion utility for Postman
- [nodemon](https://ghub.io/nodemon): Simple monitor script for use during development of a node.js app.
- [typescript](https://ghub.io/typescript): TypeScript is a language for application scale JavaScript development

## Contributor 🤓

- [POONSHT - 6010500109](https://github.com/aslupin)
- [ASMBD - 6010502748](https://github.com/asmbd)

#### APIs test
## License

```bash
npm run test:postman
```
MIT

0 comments on commit 323f1ff

Please sign in to comment.