https://github.com/taronvardanyan/journeyadvisor
Application which will allow users to find hotels, hostels and restaurants and feedback about those in whole over of world.
https://github.com/taronvardanyan/journeyadvisor
eslint gatsby javascript material-ui prettier rapidapi react-google-maps reactjs styled-components typescript yarn
Last synced: about 1 month ago
JSON representation
Application which will allow users to find hotels, hostels and restaurants and feedback about those in whole over of world.
- Host: GitHub
- URL: https://github.com/taronvardanyan/journeyadvisor
- Owner: TaronVardanyan
- Created: 2022-07-07T09:45:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-02T16:59:09.000Z (11 months ago)
- Last Synced: 2025-03-15T07:54:05.066Z (about 2 months ago)
- Topics: eslint, gatsby, javascript, material-ui, prettier, rapidapi, react-google-maps, reactjs, styled-components, typescript, yarn
- Language: JavaScript
- Homepage:
- Size: 1.39 MB
- Stars: 22
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
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
-
Installation: Clone the repository and install dependencies. -
Development: Start the development server. -
Building: Build the project for production. -
Serve: Serve the production build locally. -
Clean: Clean the Gatsby cache and public directories. -
Type Check: Run type checking using TypeScript. -
Lint: Lint the codebase. -
Format: Format the codebase. -
Test: Run type check and linting.
git clone https://github.com/TaronVardanyan/journey-advisor.git
cd journey-advisor
bun install
bun develop
bun build
bun serve
bun clean
bun typecheck
bun lint
bun format
bun test
Scripts
-
develop
: Start the Gatsby development server. -
start
: Alias fordevelop
. -
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 fortypecheck
).
Contributing
We welcome contributions to Journey Advisor! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature/my-feature
). - Commit your changes (
git commit -am 'Add new feature'
). - Push to the branch (
git push origin feature/my-feature
). - Create a new Pull Request.
License
This project is licensed under the MIT License.