Skip to content

Published 1.8.10 #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tosin-ojo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Published 1.8.10 #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ A CRUD microservice module exposing key features of a RESTful API as injected de
## Installation

```sh
$ yarn add @ctt/crud-api
$ yarn add @berryhealth/crud-api
```

## bootstrapping
To create a new CRUD service API, simply bootstrap the application by injecting the dependencies as depicted in the example below.

```ts
import { server, mysqlConnect, mongooseConnect, config } from '@ctt/crud-api';
import { server, mysqlConnect, mongooseConnect, config } from '@berryhealth/crud-api';
import { schema as mongooseSchema } from './persistence/mongoose/schema';
import routes from './routes';
import services from './services';
Expand Down Expand Up @@ -74,7 +74,7 @@ MYSQL_DB=mydb
MONGO_DB=mydb
```

You can console log `process.env` to find out available environment variables. You can also inspect the imported `config` object from `@ctt/crud-api`.
You can console log `process.env` to find out available environment variables. You can also inspect the imported `config` object from `@berryhealth/crud-api`.

## APIs

Expand All @@ -83,7 +83,7 @@ Details of each of the exposed APIs will now be explained.
### database connectors

```js
import { mysqlConnect, mongooseConnect, server } from '@ctt/crud-api';
import { mysqlConnect, mongooseConnect, server } from '@berryhealth/crud-api';

server({
...
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@ctt/crud-api",
"name": "@berryhealth/crud-api",
"version": "1.8.9",
"description": "A microservice boilerplate",
"main": "lib/index.js",
Expand Down Expand Up @@ -74,7 +74,7 @@
},
"repository": {
"type": "git",
"url": "git+ssh://git@github.com:jabdul/crud-api.git#master"
"url": "git+ssh://git@github.com:berry-health-ltd/crud-api.git#master"
},
"husky": {
"hooks": {
Expand Down