Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sloorush/posty
small social media backend written using golang + pseudo clean arch
https://github.com/sloorush/posty
go
Last synced: about 1 month ago
JSON representation
small social media backend written using golang + pseudo clean arch
- Host: GitHub
- URL: https://github.com/sloorush/posty
- Owner: sloorush
- Created: 2021-10-08T13:58:46.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-09T17:02:21.000Z (over 3 years ago)
- Last Synced: 2024-05-02T03:43:47.325Z (9 months ago)
- Topics: go
- Language: Go
- Homepage:
- Size: 223 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Posty
[](https://documenter.getpostman.com/view/11033610/UV5RkKR6)
> Modular service to add posts written in golang
## Tasks
- [x] Create an User
- [x] Get a user using id
- [x] Create a Post
- [x] Get a post using id
- [x] List all posts of a user
- [x] Authentication without using JWT
- [x] Make the server thread safe
- [x] Add pagination to the list endpoint
- [x] Add unit tests
- [x] Clean Architecture
## Instructions to run
### Direct run
- Pre-requisites:
- Go
- Installation:
```bash
git clone https://github.com/r-ush/posty.git
cd posty
go mod download
```
- Execution
- direct
```bash
DB_URL= go run api/main.go
```
_loading env because godotenv package could not be used_
- Execution using shell
```bash
chmod +x runsample
./runsample
```
- Run directly using docker!
```bash
docker run -p 8080:8080 rush3003/posty:latest
```
- Testing
- direct
```bash
DB_URL= go test api/endpoint_test.go
```
- Execution using shell
```bash
chmod +x runsample
./runsample
```
## Architecture
- This project is built in `Clean Architecture`, it contains of two main modules, i.e. api and pkg.
- `service` acts as usecase layer
- `repository` as repository layer
- `api` contains all the necessary route handlings and backend supporting services(i.e. receiving requests and forwarding to proper handlers) it contains packages:
- `main`: contains main.go.
- `presenter`: contains structs for response conditions
- `handlers`: contains all the necessaey handlers and linking with services, which in turn response using views.
- `pkg` contains the business logic divided into couple of packages
- `pkg`: contains centralized errors.go file defining all the necessary errors which will thrown from backend and pkg
- `user`: contains all the neccessary files for user business logic
- `post`: contains all the neccessary files for post business logic
- `entities`: necessary middle man structs for holding participants and meetings data from db and so forth
- `utils`: contains all necessary files for helping functions
## Other notable features
- Authentication
- Uses SHA256 hashing
- Every post made has to be authenticated with the password of the user (similar to the case with pushing to github on an https remote)
- packages
- made using only [std](https://pkg.go.dev/std) packages and [go-mongo driver](go.mongodb.org/mongo-driver)
## Documentation
Visit the postman docs [here](https://documenter.getpostman.com/view/11033610/UV5RkKR6)