aamuzakii / alexandrite

Introduction

This is a Next JS web application to display product from Odoo so that buyer can make a request to purchase.

Table of Contents

• Getting Started
  • Prerequisites
  • Install to Local Machine
• Files/Folder Structure
• Built With

Getting Started

In order to run this app on your local machine, you need to do the prequisites

Prerequisites

• Node.js version 10.13 or later
• Yarn

Install to Local Machine

Run the following commands to build an apk and install it on your device.

# copy example of env file
> cp .env.local.example .env.local

Edit the NEXT_PUBLIC_BASE_API_URL in file .env.local with url of dev/stag/prod base api url.

# Install dependencies
> yarn

# Build app and made it available on http://localhost:3000/
> yarn dev


# Test app with unit test you have been create
> yarn test

# Format the code you just added
> yarn format

Files/Folder Structure

Here is a brief explanation of the template folder structure and some of its main files usage:

└── __tests__            # unit test file for files in pages.
└── .docker              # CD (Continuous Delivery) config using jenkins
└── components           # general components used in apps
│   └── __tests__        # unit test file for files in components.
└── json                 # hardcoded data files
└── pages                # all screen in apps
└── public               # files that exposed to public
└── styles               # redux
│   └── global.scss      # global css
└── .eslinrc             # eslint config and rules.
└── .gitignore           # ignored files in Git.
└── .gitlab-ci.yml       # gitlab pipelines config for CI (Continuous Integration).
└── .prettierignore      # ignored files for prettier.
└── .prettierrc          # prettier config and rules.
└── constants.js         # constants used in apps
└── next.config.js       # next js config
└── package.json         # Package metadata and scripts
└── useFallbackImageInSSR.js # file used to display default image
└── webpack.config       # webpack config
└── yarn.lock            # Package metadata generated by yarn.

Built With

• axios
• eslint
• material ui
• next
• prettier
• react
• sass