Lab of Computational Neuroscience @SJTU

Website is powered by Jekyll with al-folio theme.

Table Of Contents

• Lab of Computational Neuroscience @SJTU
  • Table Of Contents
  • Getting started
    • Local setup
    • Installation
      • Local setup using Docker (Recommended on Windows)
      • Local Setup (Standard)
  • Quick Guide
    • Create a pull request (PR)
    • Journal Club
    • People
    • Publications
  • TODO

Getting started

Local setup

Want to learn more about Jekyll? Check out this tutorial. Why Jekyll? Read Andrej Karpathy's blog post!

Installation

For a hands-on walkthrough of al-folio installation, check out this cool video tutorial by one of the community members! 🎬 🍿

---

Local setup using Docker (Recommended on Windows)

You need to take the following steps to get al-folio up and running in your local machine:

• First, install docker and docker-compose.
• Then, clone this repository to your machine:

$ git clone git@github.com:<your-username>/<your-repo-name>.git
$ cd <your-repo-name>

Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.

$ docker-compose up

Note that when you run it for the first time, it will download a docker image of size 300MB or so.

Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, you can use the same command (docker-compose up) to render the webpage with all you changes. Also, make sure to commit your final changes.

To change port number, you can edit docker-compose.yml file.

(click to expand) Build your own docker image:

Note: this approach is only necessary if you would like to build an older or very custom version of al-folio.

Build and run a new docker image using:

$ docker-compose -f docker-local.yml up

If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again using --force-recreate argument at the end of previous command! It will download ruby and jekyll and install all ruby packages again from scratch.

---

Local Setup (Standard)

Assuming you have Ruby and Bundler installed on your system (hint: for ease of managing ruby gems, consider using rbenv), first fork the repo from github.com:LCNS-SJTU/lcns-sjtu.github.io to github.com:<your-username>/<your-repo-name> and do the following:

$ git clone git@github.com:<your-username>/<your-repo-name>.git
$ cd <your-repo-name>
$ bundle install
$ bundle exec jekyll serve --lsi

Now, feel free to change the forked repository however you like. After you are done, commit your final changes.

Quick Guide

Create a pull request (PR)

Check docs about PR creation.

Journal Club

Check here for docs about adding materials for new journal clubs.

People

Check here for docs about adding new profiles of group members.

Publications

Check here for docs about adding new bib items.

---

TODO

• Add tutorial for openning a pull-request.
• Add profile avatars for rest of group members.
• Finish the resource page.
• Create project page.