CarHub

Easily find detailed specifications for any vehicle - a modern Next.js 13 Application using TypeScript 🏎

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Folder Structure
  • Tech Stack
• Getting Started
  • Environment Variables
  • Installation
  • Run Locally
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

Discover the perfect ride for you with our advanced car search engine. Easily find detailed specifications for any brand, model, year, and fuel type.

‼️ Folder Structure

Here is the folder structure of CarHub.

Nextjs-CarHub-Web/
|- app/
    |-- globals.css
    |-- layout.css
    |-- page.tsx
|- components/
    |-- CarCard.tsx
    |-- CardDetails.tsx
    |-- CustomButton.tsx
    |-- CustomFilter.tsx
    |-- Footer.tsx
    |-- Hero.tsx
    |-- Navbar.tsx
    |-- SearchBar.tsx
    |-- SearchManufacturer.tsx
    |-- ShowMore.tsx
    |-- index.ts
|- data/
    |-- index.ts
|- types/
    |-- index.ts
|- utils/
    |-- index.ts
|- public/
|- next-env.d.ts
|- next.config.js
|- postcss.config.js
|- tailwind.config.js
|- package.json
|- tscnofig.json

👾 Tech Stack

(back to top)

🧰 Getting Started

🔑 Environment Variables

In order to use CarHub you have to create Cars By Ninja-API api key, and IMAGIN.studio account, to run this webapp, you will need to add the following environment variables to your .env file, which need to be located in root directory.

RAPID_API_KEY=<RAPID_API_KEY> // Cars By Ninja-API
RAPID_API_HOST=<RAPID_API_HOST> // Cars By Ninja-API
IMGIN_API_CUSTOMER=<IMGIN_CUSTOMER>

⚙️ Installation

Step 1:

Download or clone this repo by using the command below:

 https://github.com/ladunjexa/Nextjs-CarHub-Web.git

Step 2:

This webapp using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:

  node -v

Step 3:

In root folder execute the following command to get the required packages:

  npm install

🏃 Run Locally

Step 1:

Go to root folder and execute the following command in order to run the webapp:

  npm run dev

(back to top)

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

⚠️ License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

🤝 Contact

Liron Abutbul - @lironabutbul6 - @ladunjexa

Project Link: https://github.com/ladunjexa/Nextjs-CarHub-Web

(back to top)

💎 Acknowledgements

This section used to mention useful resources and libraries that used in CreativAI Webapp:

• Next.js
• TypeScript
• React.js
• Tailwind CSS
• Headless UI
• #JSMastery

(back to top)