Skip to content

Commit d68f777

Browse files
authored
fix typos/grammar and remove duplicate text (#393)
1 parent 99288d3 commit d68f777

8 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/docs/advanced-flag/react-vite.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ The React advanced flag can be combined with the Tailwind flag for enhanced styl
77
```bash
88
/ (Root)
99
├── frontend/ # React advanced flag. Excludes HTMX.
10-
│ ├── .env # Frontend environment configuration
10+
│ ├── .env # Frontend environment configuration.
1111
│ ├── node_modules/ # Node dependencies.
1212
│ ├── public/
1313
│ │ ├── index.html
1414
│ │ └── favicon.ico
1515
│ ├── src/ # React source files.
1616
│ │ ├── App.tsx # Main React component.
17-
│ │ ├── assets/ # React assets directory
17+
│ │ ├── assets/ # React assets directory.
1818
│ │ │ └── logo.svg
1919
│ │ ├── components/ # React components directory.
2020
│ │ │ ├── Header.tsx

docs/docs/advanced-flag/websocket.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff 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.
22

33
### Code Implementation
44

docs/docs/blueprint-core/db-drivers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To extend the project with database functionality, users can choose from a varie
44
2. [Mysql](https://github.com/go-sql-driver/mysql): Enables seamless integration with MySQL databases.
55
3. [Postgres](https://github.com/jackc/pgx/): Facilitates connectivity to PostgreSQL databases.
66
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.
88
6. [ScyllaDB](https://github.com/scylladb/gocql): Facilitates connectivity to ScyllaDB databases.
99

1010
## Updated Project Structure
@@ -36,7 +36,7 @@ Users can select the desired database driver based on their project's specific n
3636

3737
## Integration Tests for Database Operations
3838

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.
4040

4141
[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.
4242

@@ -59,7 +59,7 @@ Go to the `internal/database` directory and run the following command:
5959
go test -v
6060
```
6161

62-
or just run the following command from the root directory:
62+
Or, just run the following command from the root directory:
6363

6464
```bash
6565
make itest

docs/docs/blueprint-core/frameworks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Created project can utilizes several Go web frameworks to handle HTTP routing and server functionality. The chosen frameworks are:
1+
Created projects can utilize several Go web frameworks to handle HTTP routing and server functionality. The chosen frameworks are:
22

33
1. [**Chi**](https://github.com/go-chi/chi): Lightweight and flexible router for building Go HTTP services.
44
2. [**Echo**](https://github.com/labstack/echo): High-performance, extensible, minimalist Go web framework.

docs/docs/creating-project/project-init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To recreate the project using the same configuration semi-interactively, use the
3939
```bash
4040
go-blueprint create --name my-project --framework chi --driver mysql --git commit --advanced
4141
```
42-
This approach opens interactive mode only for advanced features, which allow you to choose the one or combination of available features.
42+
This approach opens interactive mode only for advanced features, which allows you to choose the one or combination of available features.
4343

4444
![AdvancedFlag](../public/blueprint_advanced.png)
4545

docs/docs/endpoints-test/mongo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ func (s *service) Health() map[string]string {
4444

4545
## Note
4646

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.

docs/docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Here's an overview of the project structure created by Go Blueprint when all opt
3333
│ ├── api/
3434
│ │ └── main.go # Main file for starting the server.
3535
│ └── web/
36-
│ ├── styles/ # only for generating css will not be served public
37-
│ │ └── input.css # Tailwind input file for compiling output.css with CLI when HTMX is used
36+
│ ├── styles/ # Only for generating css will not be served public.
37+
│ │ └── input.css # Tailwind input file for compiling output.css with CLI when HTMX is used.
3838
│ ├── assets/
3939
│ │ ├── css/
4040
│ │ │ └── output.css # Generated CSS file.
@@ -53,7 +53,7 @@ Here's an overview of the project structure created by Go Blueprint when all opt
5353
│ │ └── favicon.ico
5454
│ ├── src/ # React source files.
5555
│ │ ├── App.tsx # Main React component.
56-
│ │ ├── assets/ # React assets directory
56+
│ │ ├── assets/ # React assets directory.
5757
│ │ │ └── logo.svg
5858
│ │ ├── components/ # React components directory.
5959
│ │ │ ├── Header.tsx

docs/docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ Go-Blueprint provides a convenient CLI tool to effortlessly set up your Go proje
77

88
## Binary Installation
99

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:
1111

1212
```sh
1313
go install github.com/melkeydev/go-blueprint@latest
1414
```
1515

1616
This command installs the Go-Blueprint binary, automatically binding it to your `$GOPATH`.
1717

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`.
1919
2020
> 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:
2121
> Check your `GOPATH`

0 commit comments

Comments
 (0)