nionata / Offerize

a Visa Global Intern Hackathon project

Offerize

a Visa Global Intern Hackathon project

Structure

Client

powered by React

Server

powered by Strapi

API

Documentation

Setup

Client

This requires Node

Before your first start run npm install

npm run start

Server

This requires docker desktop

docker-compose up

If you are having related to dependencies, delete the node_modules folder and run up

Deployment

• The build and update server workflow will be kicked off every time code is pushed to the /server directory on the develop and master branches
• The release latest version workflow will be kicked off every time a GitHub release is published to the master branch

Client - offerize.xyz

Server - api.offerize.xyz

The api and web images are built and tagged as latest on all new commits to develop and master. Additionally, the old containers on the EC2 instance will be replaced with the latest builds. On release, the images are tagged with the version and pushed back to Dockerhub.

Contributing

Branching

Protected

• master - all commits must be made to a non-protected branch and submitted via a pull request with 1 approving reviews

Non-Protected

• develop - working branch - please refrain from commiting directly
• feature/<client/server>-<feature> - branch off of develop
• hotfix/<client/server>-<bug> - branch off of master

Git flow