SafeCityNG UI Mobile

📜 Table of Contents

• 🧐 Business context
• 🔨 Technology stack
• 💻 Project setup
• Clone this repo
• Setup .env file
• Run locally
• Compile app
• Run app

---

🧐 Business context

Project Goal

Create a Mobile Frontend UI to serve SafeCityNG

---

🔨 Technology stack

• Typescript statically typed, compiled high-level programming language

• Nuxt3 javascript meta-framework built on top of vue

• Vue3 javascript framework for building user interfaces

• UnoCss flexible and extensible atomic CSS engine

• Commits follow Conventions as per https://github.com/conventional-changelog/commitlint

---

💻 Project setup

Clone this repo

To install this project, first clone repo to your machine (use SSH) and change to directory

cd safecityng-uimobile

Install dependencies

Execute this commands in your terminal:

# npm
npm install

# yarn 
yarn install

Setup .env file

Create .env file based on .env.sample and fill in variables from a suitable source.

Run locally

# npm
npm run dev

# yarn 
yarn dev

Compile app

To compile the app run

# npm
npm run generate

# yarn 
yarn generate

Run app

To run the app run

# docker
docker build -t safecityng-uimobile .

# docker run
docker run --name=webapp -p 8080:80  -d safecityng-uimobile