The Nuxt UCSD Triple C Official Website

UCSD Triple C official website, now rewritten w/ vuejs, nuxtjs, and vuetify, coming with tons of new features!
View Demo · Report Bug · Request Feature

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Maintainence
  • Manage Member Information
  • Update Timeline
  • Update Project Readmes
  • Update Department Readmes
  • Sync Newletters
• Roadmap
• Contributing
• License
• Contact

About The Project

The next generation of the UCSD Triple C official website. It is now under intense development!

Built With

• Front-end
  • Nuxt.js
  • Vue.js
  • Vuetify
  • Misc
    • Vuex
    • Vue Router
    • Eslint
    • Babel
    • Axios
    • Prism
    • Typeit
• Back-end
  • Springboot
    • Spring Data JPA
    • Spring Security
  • MySQL
  • AWS
    • Lambda
    • Cloud Front
  • Mailchip API

Getting Started

Prerequisites

• yarn
• ucsdtriplec official web management system [installation guide (permission required)]

# macOS
$ brew install yarn

# Windows
$ choco install yarn

# CentOS / Fedora / RHEL
$ curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo

Installation

1. Clone the repo

If you are in our GitHub repo:

$ git clone https://github.com/ucsdtriplec/official-website.git

Also, you need to contact the maintainer of this repository to get the correct config file in config/index.js

If you are in our GitLab repo:

$ git clone https://gitlab.com/ucsd-triple-c/ucsdtriplec-official-web-nuxt.git

2. Install NPM packages

# install dependencies
$ yarn install

2. Build and start the server

Remember to setup the management system server before you start!

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

For detailed explanation on how things work, check out Nuxt.js docs.

Maintainence

Manage Member Information

Please refer to ucsdtriplec official web management system documentation (permission required). Once you finished, regenerate the front end to update the contents.

Update Timeline

Edit markdown files in /content/timeline. The markdown files should follow the template below.

---
title: e.g. "First Online Demo day"
date: e.g. 06/2020 (should follow DD/MM/YYYY format )
index: 10 (for sorting timeline, check on your own!)
---
A short description of the project (not required). e.g. "Demo day has been an established cultural in Triple C. We host this quarterly event to demonstrate our groups' latest achievement. Due to Covid-19, we shifted this event to streaming platform Bilibili yet still received a high volume of audience."

Update Project Readmes

Edit markdown files in /content/projects. The markdown files should follow the template below.

---
title: 'Title of the project'
description: 'description of the project'

// note: the parentheses and the position inside it are optional
team:
  - Steve Jobs (PM)
  - Jimmy Keesee (Frontend)
  - Linus Torvalds (Backend)
  - Elon Musk
---
Anything else about the project
...

Update Department Readmes

Edit markdown files in /content/departments. The markdown files should follow the template below.

---
title: 'Title of the department'
description: 'Short description or Chinese name of the department'
---
Anything else to introduce the department
...

Sync Newletters

In mailchimp, drop the newsletters to be shown to folder "newsletters". Regenerated the front end and hopefully everything will be in sync.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the GPL-3 license.

This means that you may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

Contact

Xiyan Shao - x3shao AT ucsd.edu
Dekun Ma - William AT dekun.me

GitLab Repository Link (for Triple C internal developers): ucsdtriplec-official-web-nuxt