added go project structure

AbdoAnss · Dec 8, 2024 · a410c3e · a410c3e
1 parent efe4fdf
commit a410c3e
Show file tree

Hide file tree

Showing 18 changed files with 33 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -26,22 +26,36 @@ The project follows a monolithic package architecture, organized into logical co
 
 ```
 go-fantasy-pl/
-├── client/          # Core HTTP client implementation
-│   ├── client.go    # Main client struct and configuration
-│   └── rate.go      # Rate limiting implementation
-├── models/          # Data structures for API responses
-│   ├── player.go    # Player-related structs
-│   ├── team.go      # Team-related structs
-│   └── gameweek.go  # Gameweek-related structs
-├── endpoints/       # API endpoint implementations
-│   ├── bootstrap.go # General game data
-│   ├── fixtures.go  # Match fixtures
-│   └── leagues.go   # League standings
-├── utils/          # Helper functions
-│   ├── cache.go    # Caching implementation
-│   └── helpers.go  # General utility functions
-└── examples/       # Usage examples
-    └── basic.go    # Basic usage patterns
+├── .github/             # GitHub-specific configurations
+│   └── workflows/       # GitHub Actions workflows
+│       └── ci.yml       # Continuous Integration workflow
+├── client/              # Core HTTP client implementation
+│   ├── client.go        # Main client struct and configuration
+│   ├── client_test.go   # Tests for client functionality
+│   ├── options.go       # Configuration options for the client
+│   └── rate_limiter.go  # Rate limiting implementation
+├── models/              # Data structures for API responses
+│   ├── player.go        # Player-related structs
+│   ├── team.go          # Team-related structs
+│   ├── gameweek.go      # Gameweek-related structs
+│   ├── fixture.go       # Fixture-related structs
+│   └── league.go        # League-related structs
+├── endpoints/           # API endpoint implementations
+│   ├── bootstrap.go     # General game data
+│   ├── players.go       # Player-related endpoints
+│   ├── teams.go         # Team-related endpoints
+│   ├── fixtures.go      # Match fixtures
+│   └── leagues.go       # League standings
+├── internal/            # Internal packages
+│   └── cache/           # Caching functionality
+│       └── cache.go     # Implementation of caching mechanism
+├── examples/            # Usage examples
+│   └── basic/
+│       └── main.go      # Basic usage examples
+├── .gitignore           # Ignored files and directories
+├── LICENSE              # License for the project
+├── README.md            # Project documentation
+└── go.mod               # Go module configuration
 ```
 
 ## Main Components

diff --git a/client/client.go b/client/client.go
diff --git a/client/client_test.go b/client/client_test.go
diff --git a/client/options.go b/client/options.go
diff --git a/client/rate_limiter.go b/client/rate_limiter.go
diff --git a/endpoints/bootstrap.go b/endpoints/bootstrap.go
diff --git a/endpoints/fixtures.go b/endpoints/fixtures.go
diff --git a/endpoints/leagues.go b/endpoints/leagues.go
diff --git a/endpoints/players.go b/endpoints/players.go
diff --git a/endpoints/teams.go b/endpoints/teams.go
diff --git a/examples/basic/main.go b/examples/basic/main.go
diff --git a/go.mod b/go.mod
@@ -0,0 +1,3 @@
+module github.com/AbdoAnss/go-fantasy-pl
+
+go 1.23.3
diff --git a/internal/cache/cache.go b/internal/cache/cache.go
diff --git a/models/fixture.go b/models/fixture.go
diff --git a/models/gameweek.go b/models/gameweek.go
diff --git a/models/league.go b/models/league.go
diff --git a/models/player.go b/models/player.go
diff --git a/models/team.go b/models/team.go
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		module github.com/AbdoAnss/go-fantasy-pl

		go 1.23.3