Skip to content

Carleton-Blueprint/carleton-blueprint.github.io

Repository files navigation

Carleton Blueprint

Deploys by Netlify Netlify Status

The official website for Carleton Blueprint - a student-led organization that builds technology for social good. We partner with non-profits and other organizations to create custom software solutions that help them better serve their communities.

🚀 Quick Start

  1. Prerequisites

    • Node.js (v18 or higher)
    • npm, yarn, bun or pnpm
  2. Installation

    # Clone the repository
    git clone https://github.com/carleton-blueprint/carleton-blueprint.github.io.git
    cd carleton-blueprint.github.io
    
    # Install dependencies
    npm install
    # or
    yarn install
    # or
    pnpm install
    # or
    bun install
  3. Development

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
    # or
    yarn dev
    # or
    bun dev

    Open http://localhost:3000 to view the site.

🛠️ Technologies

📁 Project Structure

├── app/           # Next.js app directory
│   ├── pages/     # Page components
│   └── api/       # API routes
├── components/    # Reusable UI components
├── lib/           # Utility functions and libraries
├── public/        # Static assets
└── styles/        # Global styles

🤝 Contributing

We welcome contributions from the community! Please check out our Contributing Guidelines for details on how to get started.

Development Workflow

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/feature-name)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add a feature')
  5. Push to the branch (git push origin feature/feature-name)
  6. Open a Pull Request (ensure adherence to the generated template)

📝 License

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

🔗 Links


For more information about Blueprint, visit our website or reach out to us at [email protected].

About

cuBlueprint Landing Page

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 16