/clientLink

clientLink

Primary LanguageVueMIT LicenseMIT


Logo

clientLink

Progressive Web App to link clients and contacts.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Recruiting exercise for a software developer position.
Demo: on YouTube.

Built With

Getting Started

Prerequisites

  • node.js

    sudo apt install nodejs # Debian/Ubuntu
brew install node # macOS
winget install nodejs # Windows

  • npm

    npm install npm@latest -g

  • browser (preferably Chrome)

Installation

Server

  1. Clone the repo or download the zip file then extract it

    git clone https://github.com/iamdanre/clientLink.git

  2. Change to project directory

    cd clientLink

  3. Install NPM packages and run server

    cd server;
npm install && npm start; # prepend & to run in background

Client

  1. Open a new terminal, navigate to project directory, then install NPM packages for the client

    cd client; # run this in a new terminal window from the project root directory
npm install;

  2. Build client

    npm run build # uses vite to build dist folder

  3. Serve client, this should open the app in your default browser

    npm run serve # uses http-server to serve dist folder

Usage

When you serve the client, the app should open in your default browser. If not, navigate to http://localhost:5173 in your browser.
Once opened, the app should prompt for installation in the URL bar. Install the app to use it as a PWA. If you don't want to install it, you can use it as a regular web app.
Note that the dist folder is not included in the repo, so you'll have to build the client before serving it.
The server uses Atlas MongoDB, so you don't have to install MongoDB locally. However, if you want to use a local MongoDB instance, you can change the connection string in server/config/db.config.js.

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

danré - @xp_x_qx - dev.danre@icloud.com

Project Link: https://github.com/iamdanre/clientLink

Acknowledgments