Table of Contents
Recruiting exercise for a software developer position.
Demo: on YouTube.
-
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)
-
Clone the repo or download the zip file then extract it
git clone https://github.com/iamdanre/clientLink.git
-
Change to project directory
cd clientLink -
Install NPM packages and run server
cd server; npm install && npm start; # prepend & to run in background
-
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;
-
Build client
npm run build # uses vite to build dist folder -
Serve client, this should open the app in your default browser
npm run serve # uses http-server to serve dist folder
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.
Distributed under the MIT License. See LICENSE.txt for more information.
danré - @xp_x_qx - [email protected]
Project Link: https://github.com/iamdanre/clientLink