HECKFREE

---

Share One and Connect with Many

The only link you will ever need

We're a tool for connecting followers to your entire online arena and manage all your links with ease.

Dashboard for managing User's Acccount

Features

Get all your links at one place

Manage Easily

Multiple Design Template to chose From

Tech-Stacks:

Our Team

---

## Environment Setup-

• Drop a ⭐ on the GitHub repository.

• Download and install a code/ text editor.
  • Recommended-
    • Download VS Code
    • Download Atom

• Download Node Js and npm(Node package manager) (when you download Node, npm also gets installed by default)

• Mongo DB community editition is free and a great software in order to work with MongoDB applications. Download Mongo DB community editition

• Robo 3T is a desktop graphical user interface (GUI) for Mongo DB. It can help to skip running all the Mongo DB commands manually every time we want to access the data. Download Robo 3T (optional)

• Clone the repository by running command

git clone https://github.com/ <your user-name> /threefreespirited/heckfree.git

in your git bash.

• Run command cd threefreespirited/heckfree.

• Run this command to install all dependencies for the project.

npm install

All the current dependencies -

  "body-parser": "^1.19.0",
    "dotenv": "^8.2.0",
    "ejs": "^3.1.5",
    "express": "^4.17.1",
    "express-session": "^1.17.1",
    "jwt-simple": "^0.5.6",
    "mongoose": "^5.10.11",
    "nodemailer": "^6.4.15",
    "passport": "^0.4.1",
    "passport-local-mongoose": "^6.0.1",
    "url": "^0.11.0"

• Run this command on your terminal/ bash to start the Mongo server on port 27017(default).

mongod

• Run this command to start the project on local host 3000.

npm start

• Open link to view the website in your browser window if it doesn't open automatically.

http://localhost:3000/

• You can learn more about EJS template engine and its syntax to know how we can use it inside our HTML using the documentation

• Now you are all set to use this project.

Some useful Mongo DB commands if you are using the terminal instead of the GUI-

show dbs
use db <db name>
show collections
<db name> .find()