Install MyLinks Locally Using npm

For most scenarios, Docker Compose is the recommended installation method due to its simplicity, ease of use, and reliability. If you prefer using npm, you can follow these instructions.

Prerequisites

Node.js 18+: https://nodejs.org/en/download
Git: https://git-scm.com/download/
MongoDB (Atlas or Community Server)
- MongoDB Atlas
- MongoDB Community Server

Installation Steps

Preparation

Run the following commands in your terminal:

Clone the Repository

git clone https://github.com/TrinhNgocThanh/mylinks.com.vn.git

Navigate to the MyLinks Directory

cd MyLinks

Create a .env File from .env.example

cp .env.example .env

Note: If you’re using Windows 10, you might need to use copy instead of cp.

Update the MONGO_URI

Important: Edit the newly created `.env` file to update the `MONGO_URI` with your own MongoDB instance URI.

❗

Update the MONGO_URI

Edit the newly created .env file to update the MONGO_URI with your own

Build and Start

Once you’ve completed the preparation steps, run the following commands:

Install dependencies

npm ci

Build the Frontend

npm run frontend

Start MyLinks!

npm run backend

🎉

Access MyLinks!

Visit http://localhost:3080/

🔥

Tip

Next time you want to start MyLinks, you only need to execute npm run backend

Update MyLinks

To update MyLinks to the latest version, run the following commands:

First, stop MyLinks (if you haven’t already).

Pull latest project changes

git pull

Update dependencies

npm ci

Rebuild the Frontend

npm run frontend

Start MyLinks!

npm run backend

Additional Setup

Unlock additional features by exploring our configuration guides to learn how to set up:

Meilisearch integration
RAG API connectivity
Custom endpoints
Other advanced configuration options
And more

This will enable you to customize your MyLinks experience with optional features.

see also:

🐋 Docker 🪖 Helm Chart