presents ...

AssignForce

<- Tech Stack - > < - Features - > < - Getting Started - > < - License ->

---

Tech Stack

• Angular (v11)
  • Material
  • Google-Maps (wrapper component for Google Maps JavaScript API)
  • Bootstrap
• Firebase (Hosting with GitHub CI)
• GitHub Actions

---

^ to top

Features

Trainers

• Registration and Signin
• Manage Personal Reservations
  • View, Edit, Add, and Cancel
• Change Password

Admins

• Inherit all Trainer Permissions
• Resolve New User Requests
• Manage Locations
  • Inspect, Add, Edit, and Delete

---

^ to top

Getting Started

1. Cloning GitHub Repo

   NOTE: don't forget to cd into your preferred folder, the project will be cloned into a new folder (named 'af-client' by default) inside the current directory ... adding localname is optional

   HTTPS Method

   git clone https://github.com/Batch-944-Adam-Ranieri/af-client.git <localname>

   SSH Method

   git clone [email protected]:Batch-944-Adam-Ranieri/af-client.git <localname>

   GitHub CLI Method

   gh repo clone Batch-944-Adam-Ranieri/af-client <localname>

2. NPM Installation

   Confirm node.js and npm are installed on your machine

   # as of 04.13.21, Node.js -> LTS v14.16.1, Current v15.14.0
   node -v
   # v15.8.0
   
   # as of 04.13.21, npm installed with node.js lts -> v6.14.12,  Current v7.7.6
   npm -v
   # 7.8.0

   Node and/or NPM not found? -> Try these options

   • Using Pre-Built installer for Node.js and NPM
   • Using package manager (brew, yum, nvm)

   Confirmed NPM and Node versions? -> CD into your newly cloned project folder and run npm install

   # note: project folder name will be af-client by default
   cd localname && npm i

3. Angular CLI Installation

   Confirm Angular CLI is installed on your machine

   # as of 04.13.21, Angular CLI 11.2.8
   ng --version
   
   # sample response below ...
   # Angular CLI: 11.2.3
   # Node: 15.8.0
   # OS: darwin x64
   
   # Angular: 
   # ... 
   # Ivy Workspace: 
   
   # Package                      Version
   # ------------------------------------------------------
   # @angular-devkit/architect    0.1102.3 (cli-only)
   # @angular-devkit/core         11.2.3 (cli-only)
   # @angular-devkit/schematics   11.2.3 (cli-only)
   # @schematics/angular          11.2.3 (cli-only)
   # @schematics/update           0.1102.3 (cli-only)

   Angular CLI Not Found?

   # install with NPM
   npm i -g @angular/cli@latest

   running older version? -> Updating Angular CLI

   Installation Help? -> Installation Guide

4. Running Locally

   Open in your browser using ng serve

   ng s -o
   # or use ng serve --open

   NOTE: if you installed the latest version of the CLI you may receive a warning, you can ignore for now, this because our global CLI version is newer than the local one used for the project, it will automatically default to the local version but you'll continue to see the error until you either update the local version or disable the warning

---

^ to top

License

By default, this project uses the MIT License

---