Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.16 KB

README.md

File metadata and controls

38 lines (23 loc) · 1.16 KB
Raw

OSSU-progress

Open Source Society University - Computer Science

Showcase your progress with the Open Source Society University's Computer Science curriculum.
Currently only Introduction to Computer Science and Core CS courses are included.

Preview

Usage

Copy src/index.html.example to src/index.html
and src/progress.json.example to src/progress.json

Alter progress.js to reflect your current progress with the course
Use the following statuses:

  • todo
  • doing
  • done

Add your name and contact info to ./index.html

Run npm install and npm run build

Note: the build script assumes that you will deploy it in the root of your site.
To deploy it in a subfolder use npm run build-subfolder (replace the part after --public-url with your subfolder name)

Tip: to try it out locally run npx serve dist

Deploy contents of ./dist to a static server

Development

Setup: npm install in the root folder

Source files are located in the ./src folder After altering files npm run build