Installation Docs

Some prerequisites for running it in your local machine

npm (Installation guide here)
mongodb installed (Installation guide here)
node version 16+ recommended. (Check your version using the node --version command) (Installation guide here)
Your are good to go to the next step.

Installing the project

fork this repository to your account
git clone the project to your local computer. The command would look something like git clone https://github.com/{Your GitHub Username}/Linker
Change the terminal to the Linker project folder using the cd Linker command on Linux and cd "Linker" command on Windows.
run npm install
Create a new .env file inside the project's root directory with the following data

SECRET=alittleandcutesecret
CLIENT_ID=fakeid
CLIENT_SECRET=fakesecret
DATABASE_URL=mongodb://127.0.0.1:27017/linkDB

Do not change any of the above value inside the .env file.
Open a new terminal window and type mongod to shart the mongoDB server.
In the previous terminal, type the command node index.js to start the server.
Go to your browser window, and check the running application. The URL would be 127.0.0.1:3000

If you have any query, feel free to ask in on the discussions forum here or join the Discord Community here.