Skip to content

Commit 62be628

Browse files
authored
Merge pull request #29 from jp-ryuji/reorder-readme
reorder README.md: place Disclaimer at last
2 parents 850e1ea + 8063939 commit 62be628

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,6 @@ This repository demonstrates the following software engineering concepts:
1313
- *Usage*: See [Individual entity](internal/domain/model/individual.go) using the Email value object
1414
- **Class Table Inheritance**: See [Renter model](internal/domain/model/renter.go) as the base class with [Company](internal/domain/model/company.go) and [Individual](internal/domain/model/individual.go) as specialized subclasses
1515

16-
## Disclaimer
17-
18-
This repository is intended for educational and demonstration purposes. It is not recommended for production use without significant modifications.
19-
20-
1. **Database Schema Management**: The project uses Ent's auto migration feature to manage database schema changes for convenience. Proper migration strategies should be implemented for production environments. For more details on how database schema updates are handled, see [Database Schema Updates](docs/database_schema_updates.md).
21-
22-
2. **Database Security**: SSL mode is disabled for database access (see [internal/infrastructure/postgres/migrate/main.go](internal/infrastructure/postgres/migrate/main.go)). This configuration is insecure and should be enabled in production environments.
23-
24-
3. **Configuration Management**: Environment variable handling is implemented in a basic way in [internal/infrastructure/postgres/client.go](internal/infrastructure/postgres/client.go). For production use, consider implementing a more robust configuration management solution such as [Viper](https://github.com/spf13/viper) or similar libraries to handle configuration files, defaults, and validation in a more structured manner.
25-
2616
## Documentation
2717

2818
Find specific documentation in the [docs/](docs/) folder:
@@ -33,3 +23,13 @@ Find specific documentation in the [docs/](docs/) folder:
3323
- [Go Development Guide](docs/golang.md)
3424
- [Database Schema Updates](docs/database_schema_updates.md)
3525
- [Ent ORM Setup](docs/ent.md)
26+
27+
## Disclaimer
28+
29+
This repository is intended for educational and demonstration purposes. It is not recommended for production use without significant modifications.
30+
31+
1. **Database Schema Management**: The project uses Ent's auto migration feature to manage database schema changes for convenience. Proper migration strategies should be implemented for production environments. For more details on how database schema updates are handled, see [Database Schema Updates](docs/database_schema_updates.md).
32+
33+
2. **Database Security**: SSL mode is disabled for database access (see [internal/infrastructure/postgres/migrate/main.go](internal/infrastructure/postgres/migrate/main.go)). This configuration is insecure and should be enabled in production environments.
34+
35+
3. **Configuration Management**: Environment variable handling is implemented in a basic way in [internal/infrastructure/postgres/client.go](internal/infrastructure/postgres/client.go). For production use, consider implementing a more robust configuration management solution such as [Viper](https://github.com/spf13/viper) or similar libraries to handle configuration files, defaults, and validation in a more structured manner.

0 commit comments

Comments
 (0)