Tripma

Flight booking website built on React, TypeScript, and SCSS

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
  • Running the Project
• Project Structure
• Contributing
• License

Introduction

Tripma is a modern flight booking website designed to provide a seamless experience for users to search and book flights. The application is built using React, TypeScript, and SCSS, ensuring a robust and maintainable codebase.

Features

• Flight search and booking
• Responsive design
• Modern UI/UX
• Built with React and TypeScript
• Styled with SCSS

Getting Started

Prerequisites

Ensure you have the following installed on your system:

• Node.js (>= 14.x)
• npm (>= 6.x)

Installation

To run this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/rovendix/tripma.git

2. Navigate to the project directory:

   cd tripma

3. Install the dependencies:

   npm install

Running the Project

To start the development server, run:

npm run dev

This will launch the app and you can view it in your browser at http://localhost:3000.

Project Structure

Here is an overview of the project's structure:

tripma/
├── public/                  # Public assets
├── src/                     # Source files
│   ├── assets/              # Static assets like images, fonts, etc.
│   ├── components/          # Reusable React components
│   ├── hooks/               # Custom React hooks
│   ├── pages/               # Page components
│   ├── services/            # API service functions
│   ├── styles/              # SCSS stylesheets
│   ├── utils/               # Utility functions
│   ├── App.tsx              # Main app component
│   ├── index.tsx            # Entry point
│   └── ...                  # Other files
├── .gitignore               # Git ignore file
├── package.json             # Project dependencies and scripts
├── README.md                # Project documentation
└── tsconfig.json            # TypeScript configuration

Contributing

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature-branch)
3. Make your changes
4. Commit your changes (git commit -m 'Add new feature')
5. Push to the branch (git push origin feature-branch)
6. Open a pull request