WOW! YOU TOO?

당신을 위한 AI 영어 선생님
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Acknowledgments

About The Project

스픽, 산타토익 등 AI 를 이용한 언어학습이 상업적인 아이디어로 주목받고 있는 가운데, 저희는 이러한 사이트 중 '가볍게' 영어공부를 할 수 있는 사이트는 찾아볼 수 없다고 생각했습니다. 바쁜 현대 사회에서 길게 시간을 내어 영어공부를 하기란 큰 결심이 필요한 일이죠. 바로 그러한 이유로, 와!너두? 가 출시되었습니다.

와!너두? 는 이런 분들을 위해 만들어졌습니다.

• 틈틈히 영어공부를 하고 싶었지만 진짜 사람과 대화하기는 부담스러웠던 분들
• 긴 시간을 영어 공부에 할애하기 어려운 분들
• 기초적인 어휘부터 어려운 독해까지 한 번에 경험해보고 싶은 분들

주요 기능

• 회원 가입 / 로그인 / 소셜 로그인

  

  • 일반 회원가입은 이메일 인증을 통해 회원가입이 가능합니다.
  • 카카오와 깃허브 계정으로도 로그인이 가능합니다. 다만 이 경우에는 프로필 수정을 할 수 없습니다.

• AI 채팅 기능

  

  • gpt api 를 이용해 chat gpt 와 실시간 영어 채팅이 가능합니다.

• 영어 단어 문제

  

  • 단어 데이터베이스에서 무작위로 10개를 가져와 단어 시험을 볼 수 있습니다.
  • 단어 데이터베이스는 총 1000개의 단어로 이루어져 있으며, 실용성 중심으로 배포된 파일을 이용하고 있습니다.
  • 틀렸거나, 맞았어도 잘 모르는 단어는 save 버튼을 통해 저장할 수 있습니다.

• 독해 지문 / 문제 생성 및 저장 기능

  

  • 로그인을 하지 않은 유저도 기존에 저장된 독해 지문에서 문제를 가져오는 기존 독해 지문 풀기가 가능합니다.
  • 로그인을 한 유저는 gpt 가 새롭게 생성해주는 지문을 일정 코인을 낸 뒤 풀고 저장할 수 있습니다.
  • 저장한 지문은 마이페이지에서 확인 가능하며, 내가 선택한 답과 정답을 보여줍니다.

• 영어 뉴스 제공 기능

  

  • NewYorkTimes api 를 이용해 만든 뉴스페이지 입니다. 기사의 내용을 대략적으로 볼 수 있고, 원한다면 클릭하여 해당 기사 링크로 이동할 수 있습니다.

• 마이페이지

  

  • 내 정보 수정 및 나의 정보를 열람할 수 있습니다.
  • 관리자라면 mypage 에서 백오피스로 들어갈 수 있습니다.

• 결제 기능

  

  • PortOne 을 통해 구현한 결제페이지입니다. 다양한 수단으로 결제할 수 있습니다.

• 백오피스

  • 단체 이메일 보내기 / 공지사항 쓰기 / FAQ 답변하기 를 할 수 있습니다.
  • is_admin 이 true 일 시 마이페이지의 '백오피스' 버튼을 통해 들어올 수 있습니다.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

크롬 브라우저 사용을 권장합니다.

Prerequisites

package.json 에서 패키지를 설치해주세요

• npm

  npm install

Installation

API 키와 url 을 APIkey.js 파일에 담아주세요

1. 카카오 개발자 홈페이지에서 회원가입을 통해 API key 를 받아주세요 https://developers.kakao.com/ github 는 settings 에서 발급받을 수 있습니다. https://github.com/settings/developers 에서 앱을 등록하고 키를 발급받아 주세요. OpenAIhttps://platform.openai.com/account/api-keys 에서 회원가입을 한 뒤 api key 를 발급받아 주세요. PortOnehttps://portone.io/korea/ko 에서 회원가입을 한 뒤 시스템 설정 > 내정보의 API key, API secret을 설정하시고 "Get Token" 버튼을 통해 토큰을 발급받아 주세요. New York Times api 문서에서 회원가입을 한 뒤 api 키를 발급받아주세요.

2. 리포지토리를 clone 받아주세요

   https://github.com/hyeleenotharry/wowyoutoo_front.git

3. package.json 를 다운받아 주세요

   npm install

4. 루트 디렉도리에 APIkey.js 를 생성한 뒤 아래의 형식으로 담아주세요

   const config = {
    apikey: "YOUR_NYTIMES_API_KEY",
    frontend_base_url: "https://wowyoutoo.me",
    backend_base_url: "https://api.wowyoutoo.me",
    KAKAO_REST_API_KEY: "YOUR_KAKAO_API_KEY",
    KAKAO_JS_KEY: "YOUR_KAKAO_JS_KEY",
    SOCIAL_AUTH_GITHUB_CLIENT_ID: "YOUR_GITHUB_CLIENT_ID",
    SOCIAL_AUTH_GITHUB_SECRET: "YOUR_GITHUB_SECRET_ID"
    }
   
    export default config

(back to top)

Contributing

저희 프로젝트에 개선할 점이 보이신다면 아래의 과정을 따라주세요!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

스파게티코드클럽 - https://www.notion.so/b025be898ca042ef9a41a8b2b5ee2660 - notion

Project Link: https://github.com/sudog1/wowyoutoo-backend.git

(back to top)

Acknowledgments

• Celery를 활용한 비동기 분산 작업
• OAuth 구현
• Channels를 활용한 웹 소켓 구현
• PortOne api를 활용한 결제 시스템
• Docker를 사용한 배포

(back to top)