https://github.com/ericksumargo/dads-engine

Microservice for client Dads (https://github.com/ErickSumargo/Dads)
https://github.com/ericksumargo/dads-engine

apollo-server graphql microservice nodejs prisma

Last synced: about 1 month ago
JSON representation

Microservice for client Dads (https://github.com/ErickSumargo/Dads)

• Host: GitHub
• URL: https://github.com/ericksumargo/dads-engine
• Owner: ErickSumargo
• License: mit
• Created: 2021-02-23T03:07:27.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-09T11:32:19.000Z (almost 4 years ago)
• Last Synced: 2024-11-07T20:32:06.802Z (3 months ago)
• Topics: apollo-server, graphql, microservice, nodejs, prisma
• Language: JavaScript
• Homepage:
• Size: 244 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[]()

[](https://dads-engine.herokuapp.com)

[![CI](https://github.com/ErickSumargo/Dads-Engine/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ErickSumargo/Dads-Engine/actions/workflows/ci.yml)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FErickSumargo%2FDads-Engine.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2FErickSumargo%2FDads-Engine?ref=badge_small)

Microservice for client [**Dads**](https://github.com/ErickSumargo/Dads) powered with GraphQL engine by Apollo GraphQL.

## Application

- Base URL: https://dads-engine.herokuapp.com

- Deployment platform: [Heroku](https://dashboard.heroku.com/)

- DBaaS provider: [JawsDB (MySQL - Kitefin 😂)](https://www.jawsdb.com/)

## Stacks

- [Apollo GraphQL](https://www.apollographql.com) - The GraphQL promoter.

- [JsonWebToken](https://github.com/auth0/node-jsonwebtoken) - JWT authenticator.

- [Node.js](https://nodejs.org/en) - The runtime environment.

- [Prisma](https://www.prisma.io) - ORM for MySQL.

## Architecture

[]()

## How to run

- Install dependencies for local `node_modules`.

```

npm install

```

- Generate Prisma Client (**experimental**).

```

npx prisma generate --schema src/database/schema.prisma

```

- Setup your local MySQL database and retrieve the URL. The URL placeholder will be:

```

mysql://USER:PASSWORD@HOST:PORT/DATABASE, 

for example: mysql://root:[email protected]:3306/dads

```

Note: If you don't set the password, you may omit the `:1234` part.







- Create new `.env` file in the root project's root folder, then set:

```

DATABASE_URL=[MYSQL_DATABASE_URL]

JWT_VERIFICATION=[SHARED_KEY] (see Contributing section 👇)

```

- Run the application.

```

npm start

```

- The default port for the application should be `4000` (you may configure it too). Now you can visit:

```

http://localhost:4000

```

## Contributing

[Let's get in touch](https://twitter.com/SumargoErick) if you're interested in contributing. Fork it, submit your PR.


Also feel free to open new issue, request features, or any kind of your support (join [**stargazers** ⭐](https://github.com/ErickSumargo/Dads-Engine/stargazers)️ | treat me [**coffee**](https://www.buymeacoffee.com/ErickSumargo) 😁).

## Licenses

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FErickSumargo%2FDads-Engine.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FErickSumargo%2FDads-Engine?ref=badge_large)