Skip to content

GitMarkTeam/gitmark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitMark

Features

GitMark is an application to manage GitHub repositories(including your starred repositories and the repositories you want to collect to a list).

The following features are applied by GitMark:

  • Manage your favorite GitHub repositories
    • Import your starred repotories from GitHub
    • Manage repository records in GitMark
  • Manage repositories by tags(Not yet)
  • Add repositories to collections
  • Share collections(Not yet)
  • Add references for specified repository(Not yet)

Demo

GitMark

How to use

It is recommended to run GitMark with docker image, you can get the image as follow:

(sudo) docker pull gitmark/gitmark

Then run with docker-compose with a 'docker-compose.yml' file like this:

gitmark:
  # restart: always
  image: gitmark/gitmark
  ports:
    - "8000:8000"
    # - "5000:5000"
  links:
    - mongo:mongo
    - redis:redis

  env_file: .env

mongo:
  # restart: always
  image: mongo:3.2

  volumes:
    - /data/db

redis:
  # restart: always
  image: redis:3.0

At least you need to set these environment variables:

# GitHub OAuth Application details:
export GITHUB_ID=some-github-id
export GITHUB_SECRET=some-github-secret

# I use basic auth with GitHub APIs, so GitHub username and password are needed
export APP_USER=someone
export APP_PASS=some_password

# Currently I use qiniu(http://www.qiniu.com/) to store images:
export QINIU_AK=some-qiniu-ak
export QINIU_SK=some-qiniu-sk
export BUCKET=some-bucket
export QINIU_URL=http://qiniu.igevin.tech/

A .env will be just enough if you are using docker:

DEBUG=true
config=prd
MONGO_HOST=mongo

GITHUB_ID=
GITHUB_SECRET=
APP_USER=
APP_PASS=

QINIU_AK=pJJ-
QINIU_SK=
BUCKET=
QINIU_URL=

allow_su_creation=false

Superuser Creation

If you set this environment varible, you can create superusers:

export allow_su_creation=true

Then you can visit the superuser creation page:

http://some-domain/accounts/registration/su/