ThaiRepose / thairepose

Website for attractions searching, planning a trip.

Home Page:https://thairepose.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

workflow codecov

ThaiRepose

ThaiRepose website is a web application that helps to find areas that users want to travel and it can help people to make decisions for making trips. People who don't even have any experience planning a trip before, it can help them to easily plan a trip. ThaiRepose.com will be a community for people who love to travel.

Project Documents

Getting Started

Requirements

Name Recommended version(s)
Python 3.9 or higher
Django 3 or higher

Install Packages

  1. Clone this project repository to your machine.

    git clone https://github.com/ThaiRepose/thairepose.git
    
  2. Get into the directory of this repository.

    cd thairepose
    
  3. Create a virtual environment.

    python -m venv venv
    
  4. Activate the virtual environment.

    • for Mac OS / Linux.
    source venv/bin/activate
    
    • for Windows.
    venv\Scripts\activate
    
  5. Install all required packages.

    pip install -r requirements.txt
    
    If you're using Windows Run this command to install caching system.
    pip install --editable src\caching\.
    
  6. Create .env file in the same level as manage.py and write down:

    DEBUG=True
    SECRET_KEY=Your-Secret-Key
    HOSTS=localhost,127.0.0.1
    BACKEND_API_KEY=Your-Google-API-key-in-server-side
    FRONTEND_API_KEY=Your-Google-API-key-in-client-side
    EMAIL_HOST_USER=email-for-send-verification-form 
    EMAIL_HOST_PASSWORD=email-password
    EMAIL_PORT=Your-configured-email-port
    EMAIL_HOST=Your-email-provider-host
    EMAIL_USE_TLS=TLS-using-true-or-false
    EMAIL_USE_SSL=SSL-using-true-or-false
    SITE_ID=1
    
    Example email configuration:
    • Gmail

    • Outlook

      Warning: If you use Gmail you have to adjust to less secure

  7. Install TailwindCSS framework.

    python manage.py tailwind install
    
  8. Build TailwindCSS frontend framework the get GUI.

    python manage.py tailwind build
    
  9. Run this command to migrate the database.

    python manage.py migrate --run-syncdb
    
  10. Start running caching system.

    tr-caching start
    
  11. Start running the server by this command in another terminal.

    python manage.py runserver
    
  12. Add Oauth API Key in Admin page in social app (e.g. in local: http://127.0.0.1:8000/admin/socialaccount/socialapp/)

    • Add provider.
    • Add client id and secret key that retrieve form API owner.
    • Add site to chosen sites.
    Instruction of getting OAuth API Key:

Team Members

Name Github
Tawan Boonma ☕️ tboonma
Tanin Pewluangsawat 💤 TaninDean
Vitvara Varavithya 💦 vitvara
Nabhan Suwanachote ☔ nabhan-au

About

Website for attractions searching, planning a trip.

https://thairepose.com

License:MIT License


Languages

Language:HTML 46.4%Language:Python 43.9%Language:JavaScript 7.5%Language:CSS 2.2%