Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattiadevivo/crm
Crm service written in Golang
https://github.com/mattiadevivo/crm
crm gofiber golang
Last synced: 5 days ago
JSON representation
Crm service written in Golang
- Host: GitHub
- URL: https://github.com/mattiadevivo/crm
- Owner: mattiadevivo
- Created: 2022-11-15T17:17:09.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-30T16:09:22.000Z (almost 2 years ago)
- Last Synced: 2024-06-19T16:36:43.162Z (5 months ago)
- Topics: crm, gofiber, golang
- Language: Go
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CRM
Crm backend service written in Golang (used as Udacity Golang project work) that uses Mysql as database for customers data usage together with **gorm** as ORM.
The web framework used in this project is **gofiber**, a really fast and simple one.
As logging library `zerlog` has been used.
**Project details**:
Backend service of a CRM web application. The server will support all of the functionalities:
- Getting a list of all customers
- Getting data for a single customer
- Adding a customer
- Updating a customer's information
- Removing a customer
When running the project the first time database schema will be automatically created and some dummy data stored.
At `http://localhost:/` you'll find a static html file describing the project.
At `http://localhost:/swagger/index.html` you'll find Swagger documentation.
## Run
Build Docker image: `docker build -t crm-backend . --build-arg GIT_TOKEN= --build-arg GIT_USER=`
Run Docker container: `docker run --network="" --env-file -p "127.0.0.1::" crm-backend`
Create updated version of Swagger:
```
go install github.com/swaggo/swag/cmd/swag@latest
swag init -g main.go --output docs/crm
```
Create Mysql Docker container:
```bash
docker-compose up -d
```
Run the server:
```bash
# export env vars
source test.env
# download dependencies
go mod tidy
# execute backend server
go run main.go
```
Check `/postman` folder and load inside Postman the `collection.json` file to have some ready-to-use requests to run against the server.
## Mysql administration
Run the command to login in mysql cli inside Mysql Docker container:
```bash
docker exec -ti mysql mysql -u crm-backend -p
```
## Environment Variables
Available log levels:
- panic (`zerolog.PanicLevel`, 5)
- fatal (`zerolog.FatalLevel`, 4)
- error (`zerolog.ErrorLevel`, 3)
- warn (`zerolog.WarnLevel`, 2)
- info (`zerolog.InfoLevel`, 1)
- debug (`zerolog.DebugLevel`, 0)
- trace (`zerolog.TraceLevel`, -1)
The application supports `debug` or `error` values for `LOG_LEVEL` env var, any other values (or no value) will be recognized as `info` level.
List of variables (see them under `/variables/env.go`):
```bash
LOG_LEVEL=debug|error
PORT=3000
MYSQL_USER=crm-backend
MYSQL_PASSWORD=crm-backend
MYSQL_ADDRESS=localhost
MYSQL_PORT=3306
MYSQL_DBNAME=crm
```
## Requirements
[Application Requirements](https://review.udacity.com/#!/rubrics/4856/view)
## References
[gofiber](https://gofiber.io/)
[gorm](https://gorm.io/)