NUCSSA Official Website
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
content 添加春晚报名表 Dec 12, 2018
scripts add cname and icons file Oct 20, 2018
src add partners and book room Nov 10, 2018
static
.editorconfig auto Oct 7, 2018
.eslintignore auto Oct 7, 2018
.eslintrc.json
.gitignore need to use yarn install deploy Oct 7, 2018
.prettierrc auto Oct 7, 2018
CODE_OF_CONDUCT.md move folder ufolder up a level Oct 7, 2018
LICENSE
README.md minor fix Oct 9, 2018
gatsby-browser.js move folder ufolder up a level Oct 7, 2018
gatsby-config.js
gatsby-node.js move folder ufolder up a level Oct 7, 2018
package-lock.json
package.json add partners and book room Nov 10, 2018
postcss.config.js move folder ufolder up a level Oct 7, 2018
yarn.lock need to use yarn install deploy Oct 7, 2018

README.md

NUCSSA-website

This is the website for NUCSSA.

Installation Guide

For Beginners

Note that it is not required to have these skills, tutorial provided in this README should be sufficient enough for you to set up this website. But it is highly recommended(and very helpful) for you to:

  • Learn some basic knowledge of how to use terminal and command lines.
  • Learn some basic knowledge of git and git commands.
  • Have some basic ideas of how web development works.

Preparing your environment

To get started with Gatsby, you’ll need to make sure you have the following software tools installed:

Step By Step Guide

  1. Install Git by following the official guide.

  2. Install Node and npm here.
    To check if you have Node.js installed, run this command in your terminal:

node -v

To confirm that you have npm installed you can run this command in your terminal:

npm -v
  1. Install Gatsby CLI:
npm install --global gatsby-cli
  1. Install Yarn. Detailed steps are provided here

For more information about preparing your environment, check out the preparing your environment page or set up tutorial on Gatsby official website.

Getting started

The first step to run NUCSSA website locally is downloading the code by cloning the repository:

git@github.com:NUCSSA/nucssa-website.git

If you get Permission denied error using ssh refer here or use https link as a fallback:

https://github.com/NUCSSA/nucssa-website.git

Go to nucssa-website folder:

cd nucssa-website

Install: to install necessary libraries:

yarn install

Develop: to hot-serve your website on http://localhost:8000

gatsby develop

After running this command, you should be able to see the website on http://localhost:8000.

Other useful commands

Build: to create static site ready to host (under /public).

gatsby build

Deploy: to deploy new changes to Github Pages

yarn run deploy

For more information about Using Gatsby CLI and how to start, please read their full documentations.

Features

  • Easy editable content in Markdown files (posts, pages and parts)

Useful links

Useful tools