PURPL-Purdue.github.io

Welcome to the PURPL-Purdue.github.io repository. This project is built with React.js and Tailwind CSS to provide a modern and responsive web experience.

Table of Contents

• Installation
• Getting Started
• Folder Structure
• Contributing

Installation

To get started with this project, you will need:

• git
• a code editor, eg. Visual Studio Code
• npm

Getting Started

1. Clone the Repository:

   git clone [email protected]:PURPL-Purdue/PURPL-Purdue.github.io.git
   cd PURPL-Purdue.github.io
   

2. Open in Preferred Code Editor

3. Install Dependencies

   npm install
   

4. Start the Development Server

   npm start
   

Folder Structure

project-name/
│
├── public/
│   ├── favicon            
│   └── fonts              # Custom fonts
│   └── images       
│
├── src/
│   ├── assets/            
│   ├── components/        # Reusable UI components
│   ├── pages/            
│       ├── facilities/    # Folder containing infrastructure project pages
│       ├── projects/      # Folder containing project pages
│       ├── Landing.js     
│       ├── Contact.js    
│       ├── etc....    
|   ├── static/            # Contains information like project info or club stats 
│   ├── App.js            
│   └── index.js          
│
├── .gitignore            
├── package.json          
└── tailwind.config.js     # Tailwind CSS configuration (eg. theme colors)