Coder Social home page Coder Social logo

mygitstar's Introduction

安装

git clone

git clone https://github.com/Sidong/MyGitStar.git

首先确保机子已经安装了 node ,可通过 homebrew 安装。

sudo brew install node

进入根目录,通过node包管理(npm)工具安装所有需要的第三方模块。

npm --registry=http://r.cnpmjs.org install

安装 mongodb。下载 Download

运行 mongodb,指定路径

mongod --dbpath=/Users/stone/data/someDB

##build

build依赖 grunt,先安装 grunt cli

npm install -g grunt-cli

build命令

grunt build

后台运行watch监视

grunt watch &

启动

config.default.js 改为 config.js,对配置文件里 GITHUB_OAUTH 填写为从Github申请的clientID/clientSecret/callbackURL

node app.js

或者

node cluster.js

目录树

.
├── Gruntfile.js // Grunt 配置
├── Procfile // Heroku 设置
├── README.md // doc
├── access.log // log
├── app.js // 主程序
├── cluster.js // 守护程序
├── config.js // 全局配置文件
├── data // data文件夹存放从github api读取的数据,用于分析
│   ├── Sample-stars.json // star样本
│   ├── Sidong-info.json // github用户信息样本
│   └── readme.js // readme api 返回数据样本
├── dbControl.js // 无作用,测试模块用
├── error.log // log
├── history.md // history
├── lib // 自己定义的库
│   ├── myGit.js // 获取github数据
│   └── util.js // 格式化日期输出
├── middlewares // 中间件
│   ├── conf.js
│   └── github_strategy.js
├── models // 数据库模型
│   ├── Owner.js // owner
│   ├── Star.js // star
│   ├── StarItem.js // star item
│   ├── User.js // user
│   └── index.js // 入口
├── node_modules // 所有需要的安装的第三方模块存放目录
├── package.json // 包说明
├── proxy // 代理,通过导入模型,操作数据库
│   ├── StarItem.js
│   ├── User.js
│   └── index.js
├── public // public静态文件,debug模式下加载本地文件,非debug模式下加载cdn文件(jquery, bootstrap, font-awesome)
│   ├── images
│   ├── javascripts
│   └── stylesheets
├── routes // 路由
│   ├── github.js // 有关github认证的所有路由
│   ├── index.js // 入口
│   ├── mystars.js // 有关管理star的所有路由
│   ├── sign.js // 有关登录/~~注册~~的所有路由
│   ├── site.js // 站点路由,只有首页
│   └── user.js // 只有用户设置页面路由
├── services
│   └── mail.js // 邮件模块(去掉注册模块,暂时未用到)
└── views // HTML模板,layout.jade是所有都会继承的,包含head,导航,footer
    ├── index.jade // 首页
    ├── layout.jade // layout
    ├── mystars.jade // 我的星星页面
    ├── readme.jade // readme页面
    ├── setting.jade // 设置页面
    └── signin.jade // 登录页面

TODO

  1. 添加readme,并用合适的方法呈现
    • 路由规则 /readme?author=Sidong&repo=my-impress
  2. 增加admin功能
    • 查看用户/用户数量/站点数据
  3. 修改数据库,将star和owner schema内嵌到staritem中,建立索引
  4. 添加测试
  5. 添加 to-read 功能?或者邮箱提醒功能?
  6. 快速分类
  7. 支持打标签功能
  8. 搜索功能
    • 基于分类搜索
    • 基于标签搜索
    • 基于repo-name搜索
    • 基于..
  9. 建议
    • 还有个建议,就是点进去某个项目之后点了备注和分类输入的时候要先删除无备注几个字
    • 写了 placeholder 再写 value 就多余了吧
    • My Star 可以移到 [首页] 和 [关于]一个 level
    • [未分类] 和 [无备注] 可不可以搞成 placeholder,否则还要先清空
    • 一行文字是没办法把description全部显示出来,多余的隐藏,用...代替

BUG记录

  1. 无设置public email的github用户无法登录的bug --> 0.2.3 / 2014-04-12 已修复

history

0.2.4 / 2014-04-24

  1. 备注栏获取焦点,全选文本
  2. 从github api更新数据后,删除unstarred项目
  3. 修改分类方法,旧版:input填写分类,改为:select选择分类,添加分类
    • 分类为空,自动删除分类
    • 添加的分类,为本地分类数据,如果没有保存一个项目到该分类下,数据库不会保存该分类

0.2.3 / 2014-04-12

  1. 修复无设置public email的github用户无法登录的bug
    • 描述:无设置public email,github oauth认证不返回,email值为null,数据库对email建立索引,导致重复值,save出错。
    • 修复:删除email索引
  2. 将 [My Star] 移到 [首页] 和 [关于]一个 level,同时更名为[#星星图形# + Star]

0.2.2 / 2014-04-10

  1. 添加admin查看app数据统计页面

0.2.2 / 2014-04-08

  1. 添加about页面
  2. 增加404页面
  3. 减少tags功能
  4. 添加readme雏形
  5. 去除delete按钮及其功能,for每次更新之后,delete的项目会重新添加
  6. 去除从Github更新按钮,更改为每次登陆mystar,服务端自动从Github更新

0.2.1 / 2014-04-07

  1. 添加starItem字段order,表示某个star的先后顺序,github api返回star的顺序就是用户star时间的顺序,最先返回的是最后star的
  2. 根据新添加的字段order,提供根据star时间排序功能

0.2.0 / 2014-04-06

  1. 申请github oauth
    • Client ID
    • Client Secret
    • Client CallbackUrl
  2. 添加github oauth
    • 通过github认证的账号
      • 无需密码
      • 会话
  3. 砍掉注册功能
  4. 修改登录
  5. 最终只实现通过Github Oauth认证
  6. 专注于管理star模块

0.1.1 / 2014-04-04

  1. 改动
    • 部署到heroku
    • 数据库查询默认按star数目顺序输出repo
    • 增加Grunt
      • jshint
      • uglify
      • autoprefixer
      • cssmin
      • watch
    • 增加 cluster.js
    • 去除starItem模型打分属性
    • 去除打分功能
    • 添加响应式设计
    • 添加bootstrap/font-awesome/jquery cdn

0.1.0 / 2014-04-03

第一个版本,大致完成以下功能

  1. 站点
    • 首页
    • 登录页面
    • 注册页面
  2. 用户管理
    • 用户注册
    • 发送邮箱激活链接
    • 激活账号
    • 用户登录
    • 登录窗口点击忘记密码,输入注册邮箱,发送邮箱密码重置链接
    • 链接重置密码
    • 登录后,用户可设置个人数据
    • 登录后,用户可重置个人密码
    • 用户退出
  3. star管理
    • star管理基本界面
    • 设置Github账号
    • 从Github读取star数据
    • 从Github更新star数据
    • 用户为star数据分类
    • 提供添加分类、备注、标签、打分四个管理star的基本功能
    • ajax提交分类、备注、标签、打分修改
    • 根据star量排序
    • 显示语言统计
    • 通过字符编码转id的方法,允许以各种字符命名分类
    • 删除某个star
  4. star界面
    • 移动在某个star项目,显示备注
  5. 安全
    • 限制用户名长度(3~20)、格式([0-9A-Za-z])
    • 邮箱格式
    • 密码长度(3~20)
  6. 其他
    • 从Github更新只会添加和更新,不会删除已经unstarred的

mygitstar's People

Contributors

sidong avatar eric-guo avatar yangwenmai avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.