Skip to content

martijnboers/WelkeDeelauto

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welkedeelauto?

product image

For years I have used shared cars, and I wanted an easy way to have all the prices listed. Since the costs of these services vary greatly and change a lot, online items/services show outdated prices. Therefore, I created this website that automatically retrieves the latest prices.

(back to top)

Built With

In true engineering spirit this project is made majorly overkill using the following technologies:

  • Next JS
  • React
  • FastAPI
  • Docker
  • Terraform
  • TailwindCSS

(back to top)

Prerequisites

This project uses a couple of development wrapper to increase developer experience. To get started install:

  • Nix
    sh <(curl -L https://nixos.org/nix/install) --daemon
  • Direnv, don't forget to hook into your terminal emulator
  • Run direnv allow in project root

Installation

  1. Get a Google Maps API key

  2. Clone the repo

    git clone [email protected]:martijnboers/WelkeDeelauto.git
  3. Change directory to frontend and install NPM packages

    npm install
  4. Enter your API in .env and set FastAPI backend

    GOOGLE_MAPS_ACCESS_TOKEN='ENTER YOUR API';
    BACKEND_URL="http://127.0.0.1:8000"
  5. Run npm run dev to start the web server

  6. Enter into backend project

  7. Run poetry install

  8. Run .venv/bin/uvicorn web:app --host 0.0.0.0 --port 8000

  9. Refresh frontend page

  10. Success!

(back to top)

Contributing

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 GPLv3 License. See LICENSE for more information.

(back to top)