Giter Club home page Giter Club logo

kube-currency-converter's Introduction

Currency Converter

Screenshot from mobile view

Context

This project was developed to demostrate the use of frontend technologies alongside backend technologies. It is a web application that essentially converts currencies of any kind to a desired currency using current/live rates.

Pre-requisite

In other to successfully run this program the following should be installed:

Create the neccessary environmental variables:

  • Generate your personal Mongodb connection string Mongodb

  • Generate a personal api key from here

Technologies

This project was made by using the following technologies:

  • React
  • React Query
  • Axios
  • NodeJs
  • Express
  • MongoDB
  • Docker
  • Kubernetes

How to run the project

This project can be ran locally and can also be ran on docker.

Local

The following steps should be followed after installing the prerequisite to run the project locally:

  1. Create a .env file in both the frontend folder and the backend folder. For the backend folder, the env file would contain:

    • MONGODB_URL=<Your-Personal-MONGODB_URL>
    • JWT_SECRET=IwillNotMakeLastAttempt

    For the Frontend folder, the env file would contain:

    • VITE_API_KEY=<Personal-VITE_API_KEY>
  2. run the command

    npm install && npm run dev

This command has to be ran in the terminal from the frontend folder and also on the backend folder to install the dependencies and run both the backend and the frontend server. The terminal will display the URLs for both your frontend server and backend server after running the commands.

Docker

This doesn't need you installing NodeJs or any dependencies on your machine. All dependencies would be installed on the docker container. To successfully run this project on docker the following steps should be taken:

  1. Install and run docker desktop on your machine, to use docker technology

  2. Update the environment variables on the docker-compose file

  3. Run the following commands

    docker-compose build

    docker-compose up

    This would build the project on a Node container and the docker-compose file will simultanously run both servers and display their urls on the terminal.

Kubernetes

-- Ongoinging development --

Links

The project has been deployed and can be found in the following links:

Web: Currency-Converter

Demo Account:
    username: Spending
    password: Oporleti1?

or
    username: jaymhorsh
    password: Ola12345.

Developed By

Jaji Moshood ####### Web Developer

Azeez Razaq ####### DevOps Engineer

Contributors GitHub repo size

kube-currency-converter's People

Contributors

gbolahan-aziz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.