/gitcourse

Build elegant interactive product documentation with gitcourse

Primary LanguageHTMLMIT LicenseMIT

Gitcourse

A front framework which can present courses made by repositories.

Here is a sample as well as a guide to this project: gitcourse-guide

Before start

This project relies on bash.

For windows uses, you need to install Windows Subsystem for Linux first.

1、Install npm

For ubuntu users(include WSL):

apt-get install nodejs npm

For macos users:

brew install nodejs npm

2、Install yarn && webpack

npm install yarn webpack -g

3、Install project packages

cd gitcourse
yarn install

4、Start a webpack-server

DOCKER_ENDPOINT=http://docker.kfcoding.com:20375/v1.24 GIT_CORS=http://code.kfcoding.com:8081 npm run start

Now you can access the gitcourse on localhost:3000.

If you have a general question about Gitcourse or some suggestions about Gitcourse we encourage you to post on our slack workspace . The maintainers and other community members are glad to talk with you.