LinkCards

LinkCards is a service that allows users to display their most important social media presences in one place! Easily editable and shareable, this service is convenient for developers and non-developers alike.

Users can connect their accounts to their LinkedIn profile in order to create their profile pictures.

Test credentials: Username: sarah2 Password: abc123

Features

• Share links to all your socials in one place (e.g. https://url/jessica1)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installing

Clone or fork this repository to make sure you have the files locally.

git clone https://github.com/nicholasboyce/linkcards.git

Note: This project manages dependencies using pnpm. Install pnpm if you don't already have it.

npm i -g pnpm

You'll need to set up MongoDB and Redis in order to get the proper functionality of this app. I recommend using Docker.

You'll also need to set up your environment variables. Please see the example.env file in the server folder. Once you've entered all the necessary values, change it to .env so that it can be read by the app.

1. Change directory into the 'frontend' folder and install the dependencies.

cd frontend && pnpm install

2. Build the files so that they can be optimized and served from the backend.

pnpm run build

3. Switch directory to the server folder and install the dependencies.

cd ../server && pnpm install

4. To start the development server, run

pnpm run dev

and for the production server, run

pnpm run start

You should see in the console logs of either case that the server is successfully listening on the PORT you specified, and that it has successfully connected to MongoDB.

If you're using Windows or a non-Unix OS that is compatible with Docker, then you can use Docker for installing and running this program. You can either pull the image from Docker Hub:

docker pull nicholasboyce/linkcards:latest

or you can build the image yourself after cloning the repository.

docker build -t linkcards:<tag-here> . 

However, please note that all Docker run programs must be on the same network in order to properly communicate with each other. You can either use Docker network:

docker network create -d bridge my-net
docker run --network=my-net -itd --name=container3 busybox

or you can just use Docker compose with the example.yaml and example.env files in the root folder. The example.env file should be edited to be .env once you've added your env variables for the LinkCards image.

docker-compose -f example.yaml up

As in the other example, you should see in the console logs of either case that the server is successfully listening on the PORT you specified (recommended to set to 3001), and that it has successfully connected to MongoDB.

Running the Tests

You can currently run the tests for the API service with

pnpm run test

LinkCards uses the native Node test runner for the backend.

Built With

Frontend:

• React - The frontend framework used
• React Router - Library for managing page rendering
• CSS Modules - Used to selectively style components

Backend

• Node.js - The Javascript runtime
• Express - The backend framework used
• MongoDB - BSON Database
• PassportJS - Authentication framework
• BCrypt - Used to securely hash and salt passwords
• csrf-sync - Used to implement synchronized CSRF protection

Authors

• Nicholas Boyce - nicholasboyce

Acknowledgments

• Frontend Mentor for the initial card design!