Skip to content

Commit

Permalink
docs: add readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@EastWon0103
EastWon0103 committed Jul 4, 2024
1 parent 67e7af9 commit ab7bf53
Showing 1 changed file with 32 additions and 29 deletions.
61 changes: 32 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
# React + TypeScript + Vite
# TOFIN ✨
![image](https://github.com/Team-Muffin/Server/assets/63653473/1f34149f-ad54-43a8-8927-bbf93e3efb7c)
> 참여형 금융 SNS **TOFIN**
MZ 세대는 금융 정보를 SNS에서 얻습니다. 그에 반해 금융 정보들은 `흩어져 있고`, `재미 없으며`, `인증되지 않은 정보`들로 넘쳐납니다.
**TOFIN**은 MZ 세대들이 다양하고 인증된 금융 정보를 재미있게 학습하고 참여할 수 있는 금융소셜 플랫폼이 되고자 합니다.
### 핵심 기능
- 핀으로 다양한 정보 공유
- 챌린지로 금융 활동 활성화
- 핀플루언서 달성

# TEAM Muffin 🧁
| 김시은 | 김민우 | 배별하 | 한다현 | 유영서 | 김동원 |
|:--------------------------------------------------------------------------:|:----------------------------------------------------------------:|:---------------------------------------------------------------------------:|:-----------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------:|
| <img src="https://avatars.githubusercontent.com/u/63188042?v=4"> | <img src="https://avatars.githubusercontent.com/u/78014844?v=4"> | <img src="https://avatars.githubusercontent.com/u/114577429?v=4"> | <img src="https://avatars.githubusercontent.com/u/52192706?v=4"> | <img src="https://avatars.githubusercontent.com/u/102814269?v=4"> | <img src="https://avatars.githubusercontent.com/u/63653473?v=4"> |
| [@lvolzdev]("https://github.com/lvolzdev") | [@bkkmw]("https://github.com/bkkmw") | [@baebyeolha]("https://github.com/baebyeolha") | [@ekgus9701]("https://github.com/ekgus9701") | [@YeongseoYoo]("https://github.com/YeongseoYoo") | [@EastWon0103]("https://github.com/EastWon0103") |
| PL<br/>상품 서버<br/>알람 서버<br/> | TL<br/> 핀 서버 <br/> CI/CD | PM<br/>챌린지 서버 <br/> 프록시 서버 | FE<br/>홈/핀/상품<br/>알림<br/>무한스크롤 | FE<br/>회원가입/자산<br/>프로필<br/>챌린지 | BE<br/>유저 서버<br/>자산 서버<br/>크레딧 서버<br/> 카프카 |

# Screenshot 📷
|<img src="https://github.com/Team-Muffin/Server/assets/63653473/52ce4909-6987-4ddf-bc74-8b9a86e48dfd">|<img src="https://github.com/Team-Muffin/Server/assets/63653473/5197d365-b000-4b16-95a1-b54cdb2b30ce">|<img src="https://github.com/Team-Muffin/Server/assets/63653473/4ae99815-94a2-4ce2-8299-80f19bc5a3a8">| <img src="https://github.com/Team-Muffin/Server/assets/63653473/9a02e816-ccd7-446c-9bdf-cc6a6eaa8f9e" width=1200> |
|---|---|---|-------------------------------------------------------------------------------------------------------------------|

# Tech
### FE
<img src="https://img.shields.io/badge/react.js-61DAFB?style=for-the-badge&logo=react&logoColor=black"/><img src="https://img.shields.io/badge/typescript-3178C6?style=for-the-badge&logo=typescript&logoColor=white"/><img src="https://img.shields.io/badge/tailwind%20CSS-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white"/><img src="https://img.shields.io/badge/zustand-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB"/>

### BE
<img src="https://img.shields.io/badge/springboot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"/><img src="https://img.shields.io/badge/java-007396?style=for-the-badge&logo=openjdk&logoColor=white"/><img src="https://img.shields.io/badge/apache%20kafka-231F20?style=for-the-badge&logo=apachekafka&logoColor=white"/><img src="https://img.shields.io/badge/docker-2496ED?style=for-the-badge&logo=docker&logoColor=white"/>
<img src="https://img.shields.io/badge/jenkins-D24939?style=for-the-badge&logo=jenkins&logoColor=white"/><img src="https://img.shields.io/badge/amazon%20ec2-FF9900?style=for-the-badge&logo=amazonec2&logoColor=white"/><img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white"/><img src="https://img.shields.io/badge/redis-FF4438?style=for-the-badge&logo=redis&logoColor=white"/>

# Architecture ⚙️
![아키텍처](https://github.com/Team-Muffin/Server/assets/63653473/19867db4-1c7b-4ec5-bc3b-cca037868d57)

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

0 comments on commit ab7bf53

Please sign in to comment.