README.md

RecordMe

Table of Contents

1. Overview
2. Frontend Details
• Stack Used
• Installation Procedure
• Directory Structure
3. Third Party Integrations
4. Environment URL(s)

RecordMe:

Project Overview

---

Frontend Details

Stack Used

• VueJs

Installation Procedure

Manual Installation

Clone the repo (default branch production-frontend-latestUI)

git clone -b production-frontend-latestUI https://github.com/Developers-Studio-Limited/RecordMe-Client.git

npm install

Configuration

cp .env.example .env

Set .env file according to your required URLs

VUE_APP_ENVIRONMENT=local
VUE_APP_BACK_END_URL=
VUE_APP_SOCKET_URL=

To run project locally:

npm run serve

---

Directory Structure

iFrame-fe
├─ Docker (Default configuration file)
├─ Dockerfile
├─ docker-compose.yml
├─ public
├─ src
│  ├─ app
│  │  ├─ App.vue
│  │  ├─ components
│  │  ├─ main.js
│  │  ├─ router
│  │  │  └─ index.js
│  │  ├─ store
│  │  │  ├─ index.js
│  │  ├─ utils
│  │  └─ views
│  ├─ assets (All icons, images and SVGs)
│  ├─ common
│  │  ├─ components (Common components)
│  ├─ constants
│  ├─ fonts (font family)
│  ├─ js (Global JS files)
│  ├─ plugins (Vuetify plugin file)
│  └─ services (API service files)

---

Environment URL(s):

Environment	Portal	Email	Password
Development	Client Portal	-	-

---