Skip to content

Amana-Bootcamp/amana-bookings

Repository files navigation

Amana Bookings

Amana Bookings is a Next.js application for managing and displaying booking-related experiences in the Amana ecosystem.

Table of Contents

  • Overview
  • Tech Stack
  • Project Structure
  • Getting Started
  • Available Scripts
  • Environment Variables
  • Development Guidelines
  • Deployment
  • Contributing
  • License

Overview

  • Purpose: Provide a foundation for booking-related pages and components within the Amana suite.
  • Status: Active development.
  • Owner: Amana Bootcamp Team.

Tech Stack

  • Framework: Next.js 15
  • Language: TypeScript
  • UI: Tailwind CSS v4
  • Runtime: Node.js (LTS)
  • React: React 19

Project Structure

app/
  globals.css
  layout.tsx
  page.tsx
public/
  *.svg
next.config.ts
postcss.config.mjs
tsconfig.json
package.json

Getting Started

Prerequisites

  • Node.js LTS (v18+ recommended)
  • npm (comes with Node) or yarn/pnpm/bun

Install dependencies

npm install
# or: yarn install | pnpm install | bun install

Run the development server

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

Open http://localhost:3000 in your browser.

Build for production

npm run build

Start production server

npm run start

Available Scripts

  • dev: next dev --turbopack – start dev server with Turbopack
  • build: next build --turbopack – build the app
  • start: next start – run the production server

Environment Variables

Create a .env.local file at the project root for local development.

Common examples (add as needed):

# Example
NEXT_PUBLIC_API_BASE_URL=
BOOKINGS_API_KEY=

Notes:

  • Do not commit secrets. .env* files are ignored by default.

Development Guidelines

  • Use TypeScript strictly (see tsconfig.json).
  • Follow component-driven development; colocate components within relevant routes when applicable.
  • Keep styles in app/globals.css or Tailwind utility classes.
  • Prefer accessible, semantic HTML.

Deployment

  • Recommended: Vercel for seamless Next.js deployments.
  • Ensure environment variables are configured in the hosting platform before deploying.

Contributing

  1. Create a feature branch: git checkout -b feat/your-feature
  2. Commit changes: git commit -m "feat: add your feature"
  3. Push branch: git push origin feat/your-feature
  4. Open a Pull Request

License

This project is intended for educational and internal use within Amana Bootcamp. If you need a formal license, open an issue to discuss.

Releases

No releases published

Packages

 
 
 

Contributors