Skip to Main Content

Documentation

Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree Repo  and the documentation source on GitHub for more information.

MongoDB Atlas for Local Development

To work on LinkFree locally, you'll need to set up a database for storing your data. MongoDB Atlas is a fully managed cloud database service that offers a free tier suitable for local development.

Follow the step-by-step instructions below to create your MongoDB Atlas account and set up the connection for LinkFree local development.

Create Your MongoDB Atlas Account

  1. Go to the MongoDB Atlas website and click on the Try Free button.
  2. Fill in your first/last name, email address, and password, and click Create your Atlas account.
  3. Check your inbox and click the verification link inside to complete your registration.

Deploy a New Database

  1. Once you've completed the registration, you will be redirected to a page to deploy your database.
  2. Choose M0 for the cluster tier. For local development, the M0 free tier is sufficient.
  3. Choose the provider and region based on your preference. Ideally, choose the region closest to your location.

image

  1. Click the Create button to deploy the database. Wait for your cluster to deploy. This may take a few minutes.

Set Up the Database User and IP Access List

  1. Once you've created the database, you will be redirected to the security quickstart pages.
  2. Fill in the username and password, and then click the Create User button to create your first database user. Note: Save your password securely, as MongoDB Atlas doesn't store it.
  3. Click the Add My Current IP Address button to add an entry to your IP access list. Only an IP address you add to the IP access list will be able to connect to your database.
  4. Click the Finish and Close button.

Set Up the Database Connection

  1. Once your cluster is ready, click the Connect button on your Database Deployments console.

image

  1. Click Drivers under the Connect to your application section.

image

  1. Find the connection string and use this connection string for the variable LINKFREE_MONGO_CONNECTION_STRING in your local .env file.

image

Remember to replace password in the connection string with the password you set up for your database user.

That's it! You have successfully set up a MongoDB Atlas database and it's now ready for use in your LinkFree local development environment.