Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/basemax/randomquotegrpc

The Random Quote Generator server is built using TypeScript and gRPC. This application consists of three distinct services, all built upon the efficient gRPC protocol: User, Auth, and Quote. These services seamlessly interact with both one another and clients through the advanced gRPC protocol.
https://github.com/basemax/randomquotegrpc

grpc grpc-javascript grpc-js grpc-typescript javascript-grpc js-grpc nestjs quote quote-generator quotes typescript

Last synced: about 23 hours ago
JSON representation

Host: GitHub
URL: https://github.com/basemax/randomquotegrpc
Owner: BaseMax
License: gpl-3.0
Created: 2023-08-06T21:15:47.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-30T17:17:45.000Z (4 months ago)
Last Synced: 2025-02-04T07:15:40.998Z (6 days ago)
Topics: grpc, grpc-javascript, grpc-js, grpc-typescript, javascript-grpc, js-grpc, nestjs, quote, quote-generator, quotes, typescript
Language: TypeScript
Homepage:
Size: 1.73 MB
Stars: 5
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Random Quote Generator using gRPC (TypeScript, Nestjs)

This application consists of three distinct services, all built upon the efficient gRPC protocol: User, Auth, and Quote. These services seamlessly interact with both one another and clients through the advanced gRPC protocol. The administrative role, held by editors, empowers them to oversee user management and quote administration. Meanwhile, users enjoy the ability to access random quotes, adding an element of serendipity to their experience.

**User Service**

The User Service provides functionality related to managing user(quote editor) information.
Methods:

- findOneById
- findOneByUsername
- createUser
- removeUser

**Auth Service**

The Auth Service handles user authentication and authorization.
Methods:

- login
- verifyToken

**Quote Service**

The Quote Service retrieves and manages quotes.

- findOneQuoteById
- randDomQuote
- createQuote
- removeQuoteById
- updateQuote

**Proto Files**

for more info about methods and input/output types check out proto directory

**API Gateway**

The API Gateway serves as an entry point for clients to communicate with the gRPC services. It translates HTTP requests to gRPC requests and vice versa.

- Port: 3000

To access the services through the API Gateway, send an HTTP request to the appropriate API endpoint, import `RandomQuoteGRPC.postman_collection.json` to Postman

![diagram](./screenshots/diagram.png)

## Demo

![all request](./screenshots/all.png)

![create quote](./screenshots/create_quote.png)

![delete quote](./screenshots/delete_quote.png)

![random quote](./screenshots/quote_random.png)

![quote by id](./screenshots/quote_by_id_not_found.png)

![quote by id](./screenshots/quote_by_id.png)

![update quote](./screenshots/update_quote.png)

![login user](./screenshots/update_quote.png)

![get all users](./screenshots/get_all_users.png)

## Installation

Clone this repository to your local machine:

```bash
git clone https://github.com/BaseMax/RandomQuoteGRPC
cd RandomQuoteGRPC
```

Install the required dependencies:

```bash
npm install
```

## Usage

Transpile the .proto file and generate gRPC TypeScript code.
proto files have already transpile libs/common/types, but if you change anything you can use:

```bash
protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out= --ts_proto_opt=nestJs=true
```

This command will generate the necessary TypeScript files from the .proto file.

**Create Admin:**

```bash
ts-node apps/user/seed/create-admin.ts
```

**Start the server:**

```bash
npm run start:dev user
npm run start:dev auth
npm run start:dev quote
npm run start:dev
```

The server will start and listen on port **3000**.

## Contributing

Contributions to the Random Quote Generator project are welcome! If you have any ideas for improvements, bug fixes, or new features, feel free to submit a pull request.

## License

The Random Quote Generator project is open-source and distributed under the GPL-3.0 License.