You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/advanced-flag/websocket.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
A `/websocket` endpoint is added in `routes.go` to facilitate websocket connections. Upon accessing this endpoint, the server establishes a websocket connection and begins transmitting timestamp messages at 2-second intervals. WS is utilized across all Go-blueprint supported frameworks. This simple implementation showcases how flexible project is.
1
+
A `/websocket` endpoint is added in `routes.go` to facilitate websocket connections. Upon accessing this endpoint, the server establishes a websocket connection and begins transmitting timestamp messages at 2-second intervals. WS is utilized across all Go-blueprint supported frameworks. This simple implementation showcases how flexible a project is.
Copy file name to clipboardExpand all lines: docs/docs/blueprint-core/db-drivers.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ To extend the project with database functionality, users can choose from a varie
4
4
2.[Mysql](https://github.com/go-sql-driver/mysql): Enables seamless integration with MySQL databases.
5
5
3.[Postgres](https://github.com/jackc/pgx/): Facilitates connectivity to PostgreSQL databases.
6
6
4.[Redis](https://github.com/redis/go-redis): Provides tools for connecting and interacting with Redis.
7
-
5.[Sqlite](https://github.com/mattn/go-sqlite3): Suitable for projects requiring a lightweight, self-contained database. and interacting with Redis
7
+
5.[Sqlite](https://github.com/mattn/go-sqlite3): Suitable for projects requiring a lightweight, self-contained database.
8
8
6.[ScyllaDB](https://github.com/scylladb/gocql): Facilitates connectivity to ScyllaDB databases.
9
9
10
10
## Updated Project Structure
@@ -36,7 +36,7 @@ Users can select the desired database driver based on their project's specific n
36
36
37
37
## Integration Tests for Database Operations
38
38
39
-
For all the database drivers but the `Sqlite`, integration tests are automatically generated to ensure that the database connection is working correctly. It uses [Testcontainers for Go](https://golang.testcontainers.org/) to spin up a containerized instance of the database server, run the tests, and then tear down the container.
39
+
For all the database drivers but `Sqlite`, integration tests are automatically generated to ensure that the database connection is working correctly. It uses [Testcontainers for Go](https://golang.testcontainers.org/) to spin up a containerized instance of the database server, run the tests, and then tear down the container.
40
40
41
41
[Testcontainers for Go](https://golang.testcontainers.org/) is a Go package that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests. The clean, easy-to-use API enables developers to programmatically define containers that should be run as part of a test and clean up those resources when the test is done.
42
42
@@ -59,7 +59,7 @@ Go to the `internal/database` directory and run the following command:
59
59
go test -v
60
60
```
61
61
62
-
or just run the following command from the root directory:
62
+
Or, just run the following command from the root directory:
Copy file name to clipboardExpand all lines: docs/docs/endpoints-test/mongo.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,4 +44,4 @@ func (s *service) Health() map[string]string {
44
44
45
45
## Note
46
46
47
-
MongoDB does not support advanced health check functions like SQL databases or Redis. Implementation is basic, providing only a simple ping response to indicate if the server is reachable and DB connection healthy.
47
+
MongoDB does not support advanced health check functions like SQL databases or Redis. The implementation is basic, providing only a simple ping response to indicate if the server is reachable and DB connection healthy.
Copy file name to clipboardExpand all lines: docs/docs/installation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,15 @@ Go-Blueprint provides a convenient CLI tool to effortlessly set up your Go proje
7
7
8
8
## Binary Installation
9
9
10
-
To install the Go-Blueprint CLI tool as a binary, Run the following command:
10
+
To install the Go-Blueprint CLI tool as a binary, run the following command:
11
11
12
12
```sh
13
13
go install github.com/melkeydev/go-blueprint@latest
14
14
```
15
15
16
16
This command installs the Go-Blueprint binary, automatically binding it to your `$GOPATH`.
17
17
18
-
> if you’re using Zsh, you’ll need to add it manually to `~/.zshrc`.
18
+
> If you’re using Zsh, you’ll need to add it manually to `~/.zshrc`.
19
19
20
20
> After running the installation command, you need to update your `PATH` environment variable. To do this, you need to find out the correct `GOPATH` for your system. You can do this by running the following command:
0 commit comments