Giter Club home page Giter Club logo

jerico-xyz's Introduction

My personal website that I built from scratch (guess who loves to code?) :)

Setup

  1. Install Go 1.18 and Node LTS 18 on your machine.
  2. Create an .xyzrc in the repo root for setting the required env vars (see Configuration section)
  3. Install Node packages using npm install
  4. Set the required env vars using source .xyzrc
  5. Start the Gin app with make go (this requires restart when changes are made in Go code)
  6. Start the React webpack server with make react-dev

Debugging

  • For React app: insert debugger statement in code, and go to developer tools in browser.
  • For Gin app: place breakpoint in VS Code, generate launch.json with make go-debug-config, and debug via Run and Debug in VS Code.

Configuration

export S3_HOST='https://s3.eu-gb.cloud-object-storage.appdomain.cloud' 
export BUCKET_NAME='name-of-s3-bucket-for-uploading-static-files'
export PORT=8000
export IBM_CLOUD_API_KEY='ibm-cloud-service-id-api-key-secret-value'
export CLOUDANT_HOST='https://some-cloudant-host-bluemix.cloudantnosqldb.appdomain.cloud'

Architecture

Application

  • The front-end is a Material UI React app written in TypeScript.
  • The back-end is a Gin app written in Go.
  • The database is NoSQL using Cloudant.

Platform

  • The app is hosted on Heroku.
  • Static files are uploaded and served using IBM Cloud Object Storage.
  • The database is an IBM Cloud Cloudant instance.
  • IBM Cloud service IDs and API keys are used to give CircleCI and the Gin app access to IBM Cloud Object Storage and Cloudant, respectively.
  • A Heroku API key is used in CircleCI for continuously deploying the service.

Testing

  • E2E tests are written using Cypress and JavaScript.

CI/CD

  • Every master commit is automatically built, deployed, and E2E tested using CircleCI.
  • E2E tests are executed daily using CircleCI.

jerico-xyz's People

Contributors

alcarasj avatar dependabot[bot] avatar

Stargazers

Omar Ibrahim avatar  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.