Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.51 KB

README.md

File metadata and controls

41 lines (32 loc) · 1.51 KB

Charum Backend

Project Information

Charum is application for forum group discussion for many topics. This application will be used by end user and admin. The end users are the main users who use the application to perform a discussion and admin are manager all data like discussions, users, and other related data. End user can discuss certain topics while admin can manage the discussions.

Technology Stack

  1. Echo - Web Framework
  2. Mongo - Database
  3. Testify - Testing
  4. Cloudinary - Image Storage
  5. JWT - Authentication Strategy
  6. AWS EC2 - Cloud Server
  7. Github Action - CI/CD
  8. Mailgun - Email Service
  9. Swagger - API Documentation
  10. Mockery - Mocking

API Documentation

Here is the API documentation for Charum Backend. You can access it here.

How to use

Prerequisites

  1. Air

Setup

  1. Copy environment file and fill it with your own values cp .env.example .env
  2. Install dependencies go mod download

Run on Local Development

  1. Run the server air

Run Unit Testing on Use Case

  1. Run the test with cover go test -coverprofile=cover ./business/...
  2. Show the coverage go tool cover -html=cover