https://github.com/rdcm/news-board

News board
https://github.com/rdcm/news-board

diesel docker docker-compose grpc grpc-rust grpc-service makefile postgres postgresql protobuf rust tonic

Last synced: 23 days ago
JSON representation

News board

• Host: GitHub
• URL: https://github.com/rdcm/news-board
• Owner: rdcm
• Created: 2024-11-05T00:43:44.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-12T10:06:56.000Z (2 months ago)
• Last Synced: 2024-11-13T14:48:00.650Z (2 months ago)
• Topics: diesel, docker, docker-compose, grpc, grpc-rust, grpc-service, makefile, postgres, postgresql, protobuf, rust, tonic
• Language: Rust
• Homepage:
• Size: 55.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: news-api/Cargo.toml

Awesome Lists containing this project

README

        
## About

Cloud-native news management api built with Rust, leveraging gRPC, PostgreSQL, and Kubernetes for scalability and efficiency.

### UseCases::Auth

`SignUp` - signup and getting `session_id`  

`SignIn` - signin and getting `session_id`  

`SignOut` - invalidate current session

### UseCases::Articles

`GetArticle` - get article by id  

`GetArticles` - get page of articles (endless paging)  

`CreateArticle` - create article  

`DeleteArticle` - delete article  

`UpdateArticle` - update article

## Environment

`brew install libpq && brew link --force libpq` - installing `libpq` for interact with postgres  

`cargo install diesel_cli --no-default-features --features postgres` - installing `diesel_cli` for build diesel    

## UP & Running

### Local::Build

`make build-dev` - build locally  

`make format` - format code  

`make lint` - lint code  

### Local::Docker

`make docker-build` - build docker images  

`make docker-up` - up api and db  

`make docker-down` - down all containers

### Local::Kubernetes

`make deploy-k8s-dev` - deploy helm chart with values for local kubernetes cluster  

`make render-k8s-dev` - render helm chart with values for local kubernetes cluster  

`make delete-k8s` - delete helm chart