Skip to content

README.md

Latest commit

 

History

History
76 lines (52 loc) · 2.37 KB

README.md

File metadata and controls

76 lines (52 loc) · 2.37 KB

SUTD Organisation of Autonomous Robotics (SOAR) Website

This repository contains the source code for the official website of the SUTD Organisation of Autonomous Robotics (SOAR). The website serves as a platform to showcase our projects, events, team members, and vision, as well as providing learning resources for the robotics community.

🚀 Technology Stack

This project is built using modern web technologies:

  • Framework: Vue.js 3 (Composition & Options API)
  • Build Tool: Vite - for fast development and bundling.
  • Language: TypeScript - for type-safe code.
  • Styling: SCSS / SASS with a custom design system.
  • State Management: Vuex
  • Routing: Vue Router

🛠️ Project Setup

Prerequisites

  • Node.js (LTS version recommended)
  • npm

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/sutdsoar_v2.git
cd sutdsoar_v2

  2. Install dependencies:

    npm install

Development

To start the development server with hot-reload:

npm run dev

The application will be available at http://localhost:5173.

Production Build

To build the project for production:

npm run build

The output files will be in the dist/ directory, ready for deployment.

📁 Project Structure

  • src/app/home: Components and logic for the main landing page (Home, About, Events, Projects, Team).
  • src/app/learn: Components for the Learning resources section.
  • src/app/shared: Reusable UI components (VueNavBar, VueGrid, ProjectCard, etc.) and styles.
  • src/app/router.ts: Application routing configuration.
  • src/app/store.ts: State management configuration.

🎨 Features

  • Responsive Design: Optimized for Desktop, Tablet, and Mobile devices.
  • Interactive Animations: Custom particle effects at the start of page.
  • Dynamic Sections: Modular components for showcasing Projects and Events.

🤝 Contributing

  1. Fork the repository.
  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.