Giter Club home page Giter Club logo

linkvault's Introduction

LinkVault

A selfhost-able bookmarking & archiving app inspired by Zotero, Raindrop.io, Pocket, and Wayback Machine.

Still work-in-progress.

Features

  • Save links as bookmarks
  • Save an archive of the saved link
  • Categorize links using tags
  • Separate saved links using folders

How to get this project up and running

This project have two parts: the front end and the back end.

To be able to run this project, make sure that you have installed these first:

  • Node, NPM, and the package manager PNPM
  • Go programming language

First, clone this repository, then cd into the directory where the repository was cloned.

After that, start running the project by doing these:

Preparing the environment variables

Inside the project's root folder, create a .env file, that will contains environment variables such as database connection, API base URLs, etc. Look at the file .env.example for the example of proper .env file.

Running the front end

  1. Compile the front end by running this:
pnpm -F web build
  1. Finally run the front end by running this:
pnpm -F web start

Running the back end

  1. Make sure that you're on the root directory of the project, change the directory into /server directory, then run these to build the project:
cd server
go build
  1. Run these command to install and start the back end:
go install
go server

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.