https://github.com/in-rich/uservice-teams
Manage inrich teams feature.
https://github.com/in-rich/uservice-teams
golang grpc inrich server
Last synced: 7 months ago
JSON representation
Manage inrich teams feature.
- Host: GitHub
- URL: https://github.com/in-rich/uservice-teams
- Owner: in-rich
- Created: 2024-07-16T18:44:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-23T20:37:52.000Z (about 1 year ago)
- Last Synced: 2025-03-24T10:50:50.096Z (about 1 year ago)
- Topics: golang, grpc, inrich, server
- Language: Go
- Homepage:
- Size: 114 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# U-Service Teams
Manage inrich teams feature.
## Requirements
- Git: Version control system
- macOS:
```bash
brew install git
```
- Ubuntu:
```bash
sudo apt install git-all
```
- Windows: Try [Git bash](https://git-scm.com/downloads)
- [Go](https://go.dev/doc/install): The main development language
- (Optional, recommended) [direnv](https://direnv.net/docs/installation.html): environment variable manager
- [Docker](https://www.docker.com/products/docker-desktop/): Run the application locally
- (Optional, recommended) Make: Automated scripts for local development
- macOS:
```bash
brew install make
```
- Ubuntu:
```bash
sudo apt-get install make
```
- Windows: Install [chocolatey](https://chocolatey.org/install) (from a PowerShell with admin privileges), then run:
```bash
choco install make
```
- [Mockery](https://github.com/vektra/mockery): Generates mocks for Go interfaces. Requires Go.
```bash
go install github.com/vektra/mockery/v2@v2.43.2
```
- [gotestsum](https://github.com/gotestyourself/gotestsum): Pretty test output. Requires Go.
```bash
go install gotest.tools/gotestsum@latest
```
## Installation
Ensure you have [SSH configured on GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh)
for your machine.
Make sure you are using git in SSH mode.
```bash
git config --global url.ssh://git@github.com/.insteadOf https://github.com/
```
Ensure the `GOPRIVATE` variable is set in your local terminal:
```bash
# You can skip this step if you have direnv configured.
export GOPRIVATE=github.com/in-rich/*
```
Install the project dependencies:
```bash
go mod download
```
Make sure Docker is running, and available as a command:
```bash
docker ps -a
```
✅ Congrats, you're ready to go!
Check your environment:
```bash
go version
# go version go1.23rc1 darwin/amd64
docker -v
# Docker version 24.0.7, build afdd53b
make -v
# GNU Make 3.81
echo $GOPRIVATE
# github.com/in-rich/*
```
## Usage
Run the server:
```bash
make run
```
Run tests:
```bash
make test
```
## For Windows Users
We recommend using a bash terminal emulator. One such example is [Git bash](https://git-scm.com/downloads).
You may also use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
In both cases, make sure the dependencies you install are available under your bash
environment. This is automatic for Git Bash, but might require a separate setup
for WSL.