Project Kororā Website

The official website for Project Kororā, a student-led space initiative at Te Herenga Waka—Victoria University of Wellington, focused on developing New Zealand's space economy through CubeSat development.

Getting Started

To set up the project locally:

Prerequisites

• Git installed (https://git-scm.com/)
• Node.js and npm installed (https://nodejs.org/)

Steps

1. Clone the repository (NOT FORK):

   git clone https://github.com/Project-Korora/projectkorora.space.git

2. Navigate to the website's directory:

   cd projectkorora.space

3. Install the dependencies:

   npm install

4. Run the development server:

   npm run dev

Open http://localhost:3000 with your browser to see the result.

For a step-by-step walkthrough (Node install, token system, Git workflow), see the Beginner Onboarding Guide.

Contributing, Documentation and Guides

We welcome contributions! Please read the docs for more information on how to get started.

• 📘 Beginner Onboarding Guide – step-by-step setup & workflow: docs/BEGINNER_GUIDE.md
• 🤝 Contributing Guide – branching, commits, PR process: .docs/CONTRIBUTING.md
• 📝 Documentation Guidelines – style & formatting rules: docs/DOCUMENTATION_GUIDELINES.md
• 🛣️ Development Plan – roadmap & milestones: docs/DEVELOPMENT_PLAN.md

Project Structure

A brief overview of the key directories in this project:

• src/app/: Contains the core application files, including layouts and components.
• src/app/(pages)/: Route group containing all main pages.
• src/app/(pages)/page.tsx: The main homepage of the application.
• src/app/components/: Component library.
• src/app/globals.css: Global styles for the application.
• tailwind.config.ts: Configuration file for Tailwind CSS utilities and theme customization.
• src/app/layout.tsx: Root layout component that defines the overall structure
• public/: Static assets like images and fonts.
• legacy_site/: Contains the files from the previous version of the website.

Tech Stack

• Next.js: A React framework that enables server-side rendering and static site generation.
• React: A JavaScript library for building dynamic user interfaces.
• TypeScript: A statically typed superset of JavaScript that enhances code quality and maintainability.
• Tailwind CSS: A utility-first CSS framework for rapidly building custom designs.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.