8000 GitHub - misshanya/mitter: My social network API
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

misshanya/mitter

Repository files navigation

Mitter

wakatime

Mitter is my Twitter-inspired “social network”.

Functionality

Users

  • Sign-Up
  • Sign-In
  • Update profile (change name)
  • Change password
  • Delete account
  • Follow another user
  • Unfollow user
  • Get my follows
  • Get my followers
  • Get my friends (users that followed you and followed by you)

Mitts

  • Create mitt
  • Update mitt (change content)
  • Get user's mitts
  • Get mitt by id
  • Like mitt
  • Delete mitt
  • Feed

API Documentation

Swagger docs are located in docs/swagger.json or docs/swagger.yaml

You can use interactive swagger on /swagger/index.html (if my server is running on localhost:8080, the swagger url will be http://localhost:8080/swagger/index.html)

Stack

  • Go
  • PostgreSQL as main DB
  • Redis (right now just for auth tokens)
  • Prometheus
  • Grafana

How to run

First, clone repo and cd into it

git clone https://github.com/misshanya/mitter
cd mitter

You also need to create .env or pass env variables directly

cp .env.example .env

And Grafana's envs (if you run it via docker compose)

cp ./config/grafana/.env.example ./config/grafana/.env

Docker compose

docker compose up -d

Build binary

go build -o server .

My plans

Users

  • Following (also WIP and testing)
  • Friends
  • Users' ratings (one user can rate another user only once (rate editing allowed))

Mitts

  • Mitts' comments
5AD6

About

My social network API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0