Merge pull request #50 from DefiFundr-Labs/docs/recfor-docs

refactor: rename module and update README to reflect new project scope

Author: demola234

Makefile

@@ -80,7 +80,7 @@ air:
 	air
 
 mock:
-	mockgen -package mockdb -destination db/mock/store.go github.com/demola234/defiraise/db/sqlc Store
+	mockgen -package mockdb -destination db/mock/store.go github.com/demola234/defifundr/db/sqlc Store
 
 # Help command
 help:

Readme.md

@@ -7,13 +7,13 @@
 
 ## What is DefiFundr?
 
-DefiFundr is a decentralized crowdfunding platform built on the Ethereum blockchain. It allows users to create and contribute to crowdfunding campaigns, and allows campaign creators to set a funding goal and deadline. If the funding goal is met before the deadline, the campaign is successful and the funds are released to the campaign creator. If the funding goal is not met before the deadline, the campaign is unsuccessful and the funds are returned to the contributors.
+DefiFundr is a revolutionary decentralized payroll and invoice management system that bridges the gap between traditional financial systems and blockchain technology. The platform provides a seamless, secure, and transparent solution for businesses to manage employee payments, handle freelancer invoices, and automate salary disbursements across both fiat and cryptocurrency channels.
 
 ## Installation
 
 ```bash
 git clone
-cd deFICrowdFunding-Backend
+cd defifundr_backend
 go mod download
 ```
 
@@ -54,58 +54,3 @@ go test ./...
 ```bash
 go test -v -cover ./...
 ```
-
-## API Documentation
-
-<!-- swagger logo and link to view -->
-
-![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white&link=https://defifundr-hyper.koyeb.app/swagger/index.html)
-[View API Documentation](https://defifundr-hyper.koyeb.app/swagger/index.html)
-
-## Database Documentation
-
-<!-- dbdiagram logo and link to view -->
-
-[DB Diagram](https://dbdocs.io/kolawoleoluwasegun567/DefiFundr)
-
-## Smart Contract Address
-
-<!-- etherscan logo and link to view -->
-
-![Ethereum](https://img.shields.io/badge/Ethereum-3C3C3D?style=for-the-badge&logo=Ethereum&logoColor=white)(https://sepolia.etherscan.io/address/0x574Bc33136180f0734fc3fa55379e9e28701395E#code)
-
-## API Endpoints
-
-| Endpoint                           |       Functionality        | HTTP method |
-| ---------------------------------- | :------------------------: | :---------: |
-| /api/v1/campaigns                  |   Create a new campaign    |    POST     |
-| /api/v1/campaigns                  |     Get all campaigns      |     GET     |
-| /api/v1/campaigns/:id              |    Get a campaign by id    |     GET     |
-| /api/v1/campaigns/owner            |  Get a campaign by owner   |     GET     |
-| /api/v1/campaigns/donation/:id     |   Get a campaign donors    |     GET     |
-| /api/v1/campaigns/donate           |    Donate to a campaign    |    POST     |
-| /api/v1/campaigns/withdraw         |  Withdraw from a campaign  |    POST     |
-| /api/v1/campaigns/myDonations      |      Get my donations      |     GET     |
-| /api/v1/campaigns/categories       |     Get all categories     |     GET     |
-| /api/v1/campaigns/categories/:id   | Get campaigns by category  |     GET     |
-| /api/v1/campaigns/search           |  Search campaigns by name  |     GET     |
-| /api/v1/campaignsTypes             |   Get all campaign types   |     GET     |
-| /api/v1/campaigns/latestCampaigns  |    Get latest campaigns    |     GET     |
-| /api/v1/user                       |      Get user details      |     GET     |
-| /api/v1/user                       |    Update user details     |    POST     |
-| /api/v1/userAddress                |    Get user by address     |    POST     |
-| /api/v1/user/avatar                |     Set profile avatar     |     GET     |
-| /api/v1/user/avatar/set            |       Select avatar        |    POST     |
-| /api/v1/user/biometrics            |       Set biometrics       |    POST     |
-| /api/v1/user/logout                |        Logout user         |    POST     |
-| /api/v1/user/password/change       |      Change password       |    POST     |
-| /api/v1/user/password              |      Create password       |    POST     |
-| /api/v1/user/password/reset        |       Reset password       |    POST     |
-| /api/v1/user/password/reset/verify | Verify password reset code |    POST     |
-| /api/v1/user/verify                |        Verify user         |    POST     |
-| /api/v1/user/verify/resend         |  Resend verification code  |    POST     |
-| /api/v1/user/checkUsername         |  Check if username exists  |    POST     |
-| /api/v1/user/privatekey            |    Get user private key    |    POST     |
-| /api/v1/user/login                 |         Login user         |    POST     |
-| /api/v1/user/renewAccess           |     Renew access token     |    POST     |
-| /api/v1/currentPrice               |   Get current ETH price    |     GET     |

go.mod

@@ -1,96 +1,3 @@
-module github.com/demola234/defiraise
+module github.com/demola234/defifundr
 
-go 1.20
-
-require (
-	github.com/aead/chacha20poly1305 v0.0.0-20170617001512-233f39982aeb
-	github.com/cloudinary/cloudinary-go v1.7.0
-	github.com/ethereum/go-ethereum v1.12.0
-	github.com/gin-gonic/gin v1.10.0
-	github.com/golang/mock v1.6.0
-	github.com/google/uuid v1.3.0
-	github.com/jackc/pgx/v5 v5.4.0
-	github.com/lib/pq v1.10.9
-	github.com/o1egl/paseto v1.0.0
-	github.com/rs/zerolog v1.29.1
-	github.com/spf13/viper v1.16.0
-	github.com/stretchr/testify v1.9.0
-	github.com/swaggo/files v1.0.1
-	github.com/swaggo/gin-swagger v1.6.0
-	github.com/swaggo/swag v1.16.1
-	golang.org/x/crypto v0.23.0
-	gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df
-)
-
-require (
-	github.com/KyleBanks/depth v1.2.1 // indirect
-	github.com/StackExchange/wmi v0.0.0-20180116203802-5d049714c4a6 // indirect
-	github.com/aead/chacha20 v0.0.0-20180709150244-8b13a72661da // indirect
-	github.com/aead/poly1305 v0.0.0-20180717145839-3fee0db0b635 // indirect
-	github.com/btcsuite/btcd/btcec/v2 v2.2.0 // indirect
-	github.com/bytedance/sonic v1.11.6 // indirect
-	github.com/bytedance/sonic/loader v0.1.1 // indirect
-	github.com/cespare/xxhash/v2 v2.2.0 // indirect
-	github.com/cloudwego/base64x v0.1.4 // indirect
-	github.com/cloudwego/iasm v0.2.0 // indirect
-	github.com/creasty/defaults v1.5.1 // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/deckarep/golang-set/v2 v2.1.0 // indirect
-	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 // indirect
-	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
-	github.com/fsnotify/fsnotify v1.6.0 // indirect
-	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
-	github.com/gin-contrib/sse v0.1.0 // indirect
-	github.com/go-ole/go-ole v1.2.1 // indirect
-	github.com/go-openapi/jsonpointer v0.20.0 // indirect
-	github.com/go-openapi/jsonreference v0.20.2 // indirect
-	github.com/go-openapi/spec v0.20.9 // indirect
-	github.com/go-openapi/swag v0.22.4 // indirect
-	github.com/go-playground/locales v0.14.1 // indirect
-	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-playground/validator/v10 v10.20.0 // indirect
-	github.com/go-stack/stack v1.8.1 // indirect
-	github.com/goccy/go-json v0.10.2 // indirect
-	github.com/gorilla/schema v1.2.0 // indirect
-	github.com/gorilla/websocket v1.4.2 // indirect
-	github.com/hashicorp/hcl v1.0.0 // indirect
-	github.com/holiman/uint256 v1.2.2-0.20230321075855-87b91420868c // indirect
-	github.com/jackc/pgpassfile v1.0.0 // indirect
-	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
-	github.com/josharian/intern v1.0.0 // indirect
-	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/klauspost/cpuid/v2 v2.2.7 // indirect
-	github.com/leodido/go-urn v1.4.0 // indirect
-	github.com/magiconair/properties v1.8.7 // indirect
-	github.com/mailru/easyjson v0.7.7 // indirect
-	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/mitchellh/mapstructure v1.5.0 // indirect
-	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
-	github.com/modern-go/reflect2 v1.0.2 // indirect
-	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/redis/go-redis/v9 v9.7.0 // indirect
-	github.com/shirou/gopsutil v3.21.4-0.20210419000835-c7a38de76ee5+incompatible // indirect
-	github.com/spf13/afero v1.9.5 // indirect
-	github.com/spf13/cast v1.5.1 // indirect
-	github.com/spf13/jwalterweatherman v1.1.0 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/subosito/gotenv v1.4.2 // indirect
-	github.com/tklauser/go-sysconf v0.3.5 // indirect
-	github.com/tklauser/numcpus v0.2.2 // indirect
-	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
-	github.com/ugorji/go/codec v1.2.12 // indirect
-	golang.org/x/arch v0.8.0 // indirect
-	golang.org/x/net v0.25.0 // indirect
-	golang.org/x/sys v0.20.0 // indirect
-	golang.org/x/text v0.15.0 // indirect
-	golang.org/x/time v0.9.0 // indirect
-	golang.org/x/tools v0.12.0 // indirect
-	google.golang.org/protobuf v1.34.1 // indirect
-	gopkg.in/alexcesaro/quotedprintable.v3 v3.0.0-20150716171945-2caba252f4dc // indirect
-	gopkg.in/ini.v1 v1.67.0 // indirect
-	gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
-)
+go 1.23