Official website for Geaux Specialist LLC, developed with Next.js.
- Overview
- Features
- Tech Stack
- Getting Started
- Project Structure
- Deployment
- CI/CD
- Testing
- Contributing
- License
- Contact
GeauxSpecialist.com serves as the central hub for Geaux Specialist LLC, showcasing the company's various projects:
- Geaux Academy (education platform)
- Geaux HelpED (healthcare management)
- ReanimatED Echos (voice processing technology)
- Geaux Emporium (e-commerce for educational resources)
- Responsive design optimized for all device sizes
- Modern, clean UI with intuitive navigation
- Comprehensive project showcases
- Contact form with validation
- SEO-optimized content
- Fast loading performance
- Accessibility compliance (WCAG 2.1 AA)
- Framework: Next.js
- Styling: CSS Modules
- Deployment: Vercel
- Testing: Jest and React Testing Library
- Linting: ESLint and Prettier
- CI/CD: GitHub Actions
- Node.js (v14.x or later)
- npm (v7.x or later) or Yarn (v1.22.x or later)
- Git
-
Clone the repository:
git clone https://github.com/[your-organization]/geauxspecialist.git cd geauxspecialist -
Install dependencies:
npm install # or yarn install -
Create environment files:
cp .env.example .env.local
-
Update environment variables in
.env.localas needed.
Start the development server:
npm run dev
# or
yarn devOpen http://localhost:3000 in your browser to see the result.
geauxspecialist/
├── components/ # Reusable UI components
│ ├── layout/ # Layout components (header, footer, etc.)
│ ├── sections/ # Page sections (hero, features, etc.)
│ └── ui/ # UI elements (buttons, cards, etc.)
├── pages/ # Next.js pages
│ ├── projects/ # Project-specific pages
│ │ ├── geaux-academy.js
│ │ ├── geaux-helped.js
│ │ ├── reanimated-echos.js
│ │ └── geaux-emporium.js
│ ├── _app.js # Custom App component
│ ├── _document.js # Custom Document component
│ ├── index.js # Home page
│ ├── about.js # About page
│ ├── projects.js # Projects overview page
│ └── contact.js # Contact page
├── public/ # Static assets
│ ├── images/ # Image files
│ ├── fonts/ # Font files
│ └── favicon.ico # Site favicon
├── styles/ # Global styles and CSS modules
│ ├── globals.css # Global CSS
│ └── *.module.css # Component-specific CSS modules
├── utils/ # Utility functions
├── .github/ # GitHub configuration
│ └── workflows/ # GitHub Actions workflows
├── tests/ # Test files
├── .eslintrc.js # ESLint configuration
├── .prettierrc.js # Prettier configuration
├── jest.config.js # Jest configuration
├── next.config.js # Next.js configuration
├── package.json # Project dependencies
└── README.md # Project documentation
The website is automatically deployed to Vercel through GitHub Actions:
developbranch deploys to staging: staging.geauxspecialist.commainbranch deploys to production: geauxspecialist.com
CI/CD is implemented using GitHub Actions workflows:
- Lint: Validates code style and quality
- Test: Runs unit and integration tests
- Build: Builds the application
- Deploy: Deploys to Vercel staging or production environments
We use Jest and React Testing Library for testing:
# Run tests
npm test
# Run tests with coverage
npm test -- --coverage
# Run tests in watch mode
npm test -- --watchPlease read our Contributing Guidelines and Development Guide before submitting contributions.
This project is proprietary and confidential. Unauthorized copying, distribution, or use is strictly prohibited.
For questions or inquiries, please contact the development team at dev@geauxspecialist.com.