Skip to content

RezzaFairusNugraha/CultureConnect-Client

 
 

Repository files navigation

CultureConnect: AI-Powered Cultural & Tourism Platform

Welcome to our CultureConnect project! 🎉

This repository contains the client-side implementation of CultureConnect, an AI-powered platform designed to enhance cultural and tourism experiences.


🚀 About CultureConnect

CultureConnect is a web-based platform that leverages AI technology to provide users with immersive cultural and tourism experiences. Our goal is to bridge the gap between travelers and local cultures through intelligent recommendations, interactive content, and a seamless user experience.


📜 Terms & Conditions

Before cloning this repository, please take note of the following:

  • Ensure that you are a member of our team. If you are not, but wish to contribute, please submit a Pull Request (PR) following the proper guidelines.
  • Always use your real GitHub account when contributing.
  • Do not engage in inappropriate activities within the repository.

📥 How to Clone & Set Up the Project

Follow these steps to clone and run the project on your local machine:

1️⃣ Clone the Repository

# Open a terminal or Git Bash
cd path/to/your/directory

git clone https://github.com/CultureConnect-team/CultureConnect-Client.git

Alternatively, you can find the Git link on the repository page under the "Code" tab.

2️⃣ Open the Project in Your IDE

  • Navigate to the cloned folder: CultureConnect-Client
  • Open it in your preferred IDE (e.g., VS Code, WebStorm, Atom).

3️⃣ Install Dependencies

npm install

4️⃣ Run the Project

npm run dev

This will start the development server and you can access the app via localhost:3000 (or another available port).


🏗 Project Structure

The folder structure follows industry best practices:

CultureConnect-Client/
│-- public/            # Static assets (images, fonts, etc.)
│-- src/
│   │-- components/    # Reusable UI components
│   │-- pages/         # Main application pages
│   │-- services/      # API service handlers
│   │-- hooks/         # Custom React hooks
│   │-- styles/        # Global and component-specific styles
│   │-- utils/         # Utility functions
│-- .gitignore         # Files ignored by Git
│-- package.json       # Project dependencies & scripts
│-- README.md          # Documentation (you're reading this!)

🤝 Contributing

We welcome contributions from all developers! If you want to contribute:

  1. Fork the repository
  2. Create a new branch (feature/your-feature-name)
  3. Make your changes and commit with descriptive messages
  4. Push to your forked repository
  5. Submit a Pull Request 🚀

📌 Pull Request Guidelines

To ensure a smooth collaboration, please follow these PR guidelines:

  • Use meaningful branch names (e.g., fix/login-bug, feature/add-search-bar).
  • Write clear commit messages that describe your changes concisely.
  • Follow coding standards and ensure your code is formatted properly.
  • Test your changes before submitting the PR.
  • Reference related issues in your PR description (e.g., Closes #123).
  • Keep PRs focused on a single feature or fix.
  • Engage in code reviews by addressing feedback and making necessary changes.

🔧 Troubleshooting

If you encounter any issues:

  • Ensure Node.js and npm are installed (node -v & npm -v).
  • Try removing node_modules and package-lock.json, then reinstalling dependencies:
    rm -rf node_modules package-lock.json
    npm install
  • Restart your development server.
  • If the issue persists, check the GitHub Issues section or reach out to the team.

📌 License

This project is licensed under the MIT License – see the LICENSE file for details.


Happy coding! 🎨🌍✨

About

Welcome to CultureConnect project!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.8%
  • Other 0.2%