SpringBootRestApiTemplate

Index

• Overview
• Getting Started
• Contributing
• Authors
• License
• Deployment
• Used or Referenced Projects

About SpringBootRestApiTemplate

This Project is for Quick Start Spring boot Restful Api Server
This project provides a simple community functions.

Overview

Provide Features

• Community Api - See Rest Api Docs
• Error Report System(to SLACK)
• JWT Authentication(use AccessToken and RefreshToken)
• Pull Request Auto BuildTest
• Build Docker image when merged develop(test) and master(release) branch
• Class Document

ErrorCode Rules

account 	0000
community	1000
post		1100
comment		1200
system		2000

Getting Started

Dependencies

• JDK11
• All dependencies are managed by gradle

Deployment

this project build docker image automatically so deploy on docker

login github docker registry

sudo docker login https://docker.pkg.github.com --username [userName]

Deploy on server

• deploy test server(develop branch)

sudo docker run -d  -p 8080:8080 --name=testserver \
-v /etc/localtime:/etc/localtime:ro  -e TZ=Asia/Seoul  --restart=unless-stopped \
docker.pkg.github.com/always0ne/springbootrestapitemplate/test:version

• deploy running server(master branch)

sudo docker run -d  -p 8080:8080 --name=server \
-v /etc/localtime:/etc/localtime:ro  -e TZ=Asia/Seoul  --restart=unless-stopped \
docker.pkg.github.com/always0ne/springbootrestapitemplate/release:version

Contributing

If you see this project and have any points to improve or do not understand, please post any issues or Pull Requests. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Always0ne - SangIl Hwang - si8363@soongsil.ac.kr

See also the list of contributors who participated in this project.

Used or Referenced Projects

• spring-logback-slack-notification-example - LICENSE ?
  • referenced to create an error notification function.

License

MIT License

Copyright (c) 2020 always0ne

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.