Skip to content

Latest commit

 

History

History
81 lines (76 loc) · 3.42 KB

README.md

File metadata and controls

81 lines (76 loc) · 3.42 KB
Raw

Journey Advisor

Journey Advisor is a project designed to provide personalized travel advice and recommendations. Leveraging the power of Gatsby and various web technologies, Journey Advisor offers a seamless and interactive experience for travelers.

Features

  • Material UI: Beautiful and responsive UI components with Material UI.
  • Google Maps Integration: Easily integrate and use Google Maps in your application.
  • MDX Support: Write JSX in Markdown for creating interactive content.
  • SEO Optimization: Enhance SEO with React Helmet.
  • Styled Components: Utilize styled-components for styling React components.
  • Type Safety: Ensure type safety with TypeScript.

Getting Started

  1. Installation: Clone the repository and install dependencies.
    2. git clone https://github.com/TaronVardanyan/journey-advisor.git
cd journey-advisor
bun install
  2. Development: Start the development server.
    3. bun develop
  3. Building: Build the project for production.
    4. bun build
  4. Serve: Serve the production build locally.
    5. bun serve
  5. Clean: Clean the Gatsby cache and public directories.
    6. bun clean
  6. Type Check: Run type checking using TypeScript.
    7. bun typecheck
  7. Lint: Lint the codebase.
    8. bun lint
  8. Format: Format the codebase.
    9. bun format
  9. Test: Run type check and linting.
    10. bun test

Scripts

  • develop: Start the Gatsby development server.
  • start: Alias for develop.
  • build: Build the project using Gatsby for production.
  • serve: Serve the production build using Gatsby.
  • clean: Clean the Gatsby cache and public directories.
  • typecheck: Run type checking using TypeScript.
  • format: Format the codebase using Prettier.
  • test: Run type check and linting.
  • lint: Lint the codebase using ESLint.
  • type-check: Run type checking using TypeScript (alias for typecheck).

Contributing

We welcome contributions to Journey Advisor! To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/my-feature).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature/my-feature).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License.