Kate-Chu/twitter-api-2020

JavaScript

介紹

以 twitter 規格發想的簡易 simple twitter 專案
分別以 Vue.js 打造前端使用者介面，後端使用 Node.js 搭配 Express 框架建構，使用關連式資料庫 mysql 作為 database
使用者可以在專案中發布推文、留言、按讚、追蹤使用者，管理者則能夠在後台管理所有使用者以及留言。
本 repository 為專案後端 repository

圖片範例

登入頁

一般使用者首頁

一般使用者 Profile 頁

API 文件

產品功能

使用者可以註冊個人帳號，並使用個人帳號登入，編輯個人資料，包括名稱、帳號、密碼、email、介紹、個人顯示圖片及背景圖片。
使用者可以發布自己的文字推文訊息。
使用者可以瀏覽其他使用者的推文訊息，對推文新增回覆、按讚。
使用者可以追蹤其他使用者或取消追蹤。
使用者可以瀏覽其他使用者個人介紹頁面，瀏覽對方的歷史推文、留言、按讚的內容、追蹤中的使用者及追蹤該名使用者的清單。
後台管理者可以瀏覽所有使用者以及所有發布的推文，並且管理者能夠刪除推文。
所有使用者的帳戶密碼經過雜湊處理存入資料庫，以提高安全性。

雲端部署

完整專案
前端部署於 Github Page
後端伺服器部署於 Heroku ，雲端資料庫則使用 Cleardb 儲存

專案後端開發人員

Kate-Chu
yanpin0524

專案前端開發人員

SeijoHuang
IreneLIU

完整專案本地安裝流程

請確認電腦已經安裝 Node.js、npm 與 Mysql workbench
打開終端機，輸入以下指令將此專案 clone 到本地

git clone https://github.com/Kate-Chu/twitter-api-2020

終端機移動至專案資料夾，輸入指令安裝套件

cd 專案資料夾
npm install

安裝完畢後，請開啟 Mysql Workbench，進入資料庫後，輸入以下指令建立資料庫

CREATE DATABASE ac_twitter_workspace;

打開 config 資料夾內的 config.json 檔案，確認 development 資料庫環境設定與本機資料相符

  "development": {
    "username": "資料庫使用者帳號",
    "password": "資料庫密碼",
    "database": "ac_twitter_workspace",
    // ...
  },

在終端機依序輸入以下內容，建立相關資料表以及種子資料

npx sequelize db:migrate
npx sequelize db:seed:all

新增 .env 檔案，根據 .env.example 補足所需變數設定

SESSION_SECRET=自訂加密salt
JWT_SECRET=自訂加密salt
IMGUR_CLIENT_ID=可使用的 Imgur id
GITHUB_PAGE=前端頁面網址（如果使用本地 Vue page，則不需加入此項）

當種子資料建立完畢後，請繼續輸入以下內容，開始運行後端伺服器

npm run dev

若是跑出以下內容，代表伺服器已經成功運行了

Example app listening on http://localhost:3000

開啟另一個終端機分頁，複製專案前端程式至本地

git clone https://github.com/Irene289/twitter-front-end-vue.git

終端機移動至專案資料夾，輸入指令安裝套件、建立 Vue Page 以及運行前端伺服器

cd 專案資料夾
npm install
npm run build
npm run serve

前端終端機若是出現下列指令表示運行成功

App running at:
  - Local:   http://localhost:8080/ 
  - Network: http://172.20.10.2:8080/

確認已經使用兩個終端機頁面分別運行前端伺服器以及後端伺服器，即能使用下列網址進入專案介面，
並能使用以下模擬帳號登入及體驗網站

http://localhost:8080/

一般帳號 user1@example.com
密碼 12345678

管理員帳號 root@example.com
密碼 12345678

要結束運行請分別在兩個終端機頁面按下 ctrl + c 即可終止程式。
若要刪除資料庫，可在後端終端機輸入以下指令，即可刪除相關資料。

npx sequelize db:drop

後端開發工具

bcryptjs: v2.4.3
body-parser: v1.18.3
chai: v4.2.0
cloudinary: v1.23.0
cors: v2.8.5
dotenv: v16.0.0
eslint: v7.32.0
eslint-config-standard: v16.0.3
eslint-plugin-import: v2.23.4
eslint-plugin-node: v11.1.0
eslint-plugin-promise: v5.1.0
express: v4.16.4
express-handlebars: v6.0.5
express-session: v1.15.6
faker: v4.1.0
imgur: v1.0.2
jsonwebtoken: v8.5.1
mocha: v6.0.2
multer: v1.4.2
multer-storage-cloudinary: v4.0.0
mysql2: v1.6.4
passport: v0.4.0
passport-jwt: v4.0.0
passport-local: v1.0.0
pg: v8.7.3
sequelize: v6.18.0
sequelize-cli: v5.5.0
sinon: v10.0.0
sinon-chai: v3.3.0
sqlite3: v5.0.8