Nemesis-AS / bookmark-manager-rs

[WIP] A simple yet robust bookmark manager with tagging support
MIT License
1 stars 0 forks source link

Bookmark Manager

Bookmark Manager is a web application for managing bookmarks. It is built using Rust with the Actix web framework and Diesel ORM for database interactions.

Features

Project Architecture

Server (server/)

The server is the core of the app and contains the actual functionality of managing the bookmark database.

Server Stack

Browser Extension (extension/)

[WIP] The extensions will allow the users to export/import their bookmarks and also add and access the bookmarks easily.\

Frontend

[Planned] A web Interface is also planned to be bundled with the server to allow the users to manage their bookmarks without the need of an extension.

Getting Started

Prerequisites

Running the Server Locally

  1. Clone the repository:

    git clone https://github.com/Nemesis-AS/bookmark-manager-rs.git
    cd bookmark-manager-rs/server
  2. Set up the environment variables:

    Create a .env file in the root directory and add the following:

    DATABASE_URL=db.sqlite3

    A .env.example file has been provided. Just fill in the data and rename it to .env

  3. Run the database migrations:

    diesel migration run

    Note: This step currently requires the Diesel CLI, it will be moved to embedded migrations at some point in the near future.

  4. Build and run the server:

    cargo run
  5. The server will be running at http://127.0.0.1:8080.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.