Skip to content

Commit

Permalink
Add READMEs for backend folders
Browse files Browse the repository at this point in the history
  • Loading branch information
Alfex4936 committed May 9, 2024
1 parent a50e926 commit ac80df0
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 1 deletion.
1 change: 0 additions & 1 deletion backend-spring/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
README.md
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
Expand Down
27 changes: 27 additions & 0 deletions backend-spring/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# chulbong-kr

> [!WARNING]
> Work in progress...
chulbong-kr 을 Spring Boot 3을 이용해 만드는 과정

# TODO
- [x] 프로젝트 기본 설정
- [x] Security 6
- [x] MySQL 연동
- [x] JPA 연동
- [x] Lombok 연동
- [ ] Swagger 연동
- [ ] JUnit 연동
- [ ] ElasticSearch 연동
- [ ] controller
- [ ] marker
- [x] GET /markers
- [ ] user
- [ ] report
- [ ] comment
- [ ] ranking
- [ ] service
- [ ] repository
- [ ] util
- [ ] external APIs
27 changes: 27 additions & 0 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# chulbong-:kr:

## Technologies and Frameworks

Below is the list of technologies and frameworks used in the Chulbong-KR backend:

- **Programming Language**: Go v1.22.3
- **Web Framework**: Fiber v2
- **Database**: MySQL 8
- **Caching**: Dragonfly (Redis-compatible)
- **Search Engine**: ZincSearch (Elasticsearch-compatible)
- **Chatting**: gorilla Websocket

## Dependency Management

- **Dependency Injection**: The project utilizes [Uber Fx](https://github.com/uber-go/fx) for managing dependencies effectively, following best practices in modularity and maintainability.

## Coding Conventions

- **Standards Followed**:
- Google's Go programming language conventions
- Uber's Go style guide

## Code Quality

- **Linter Configuration**:
- See `revive.toml` for the linter settings used to ensure code quality and consistency across the project.

0 comments on commit ac80df0

Please sign in to comment.