Isabella

Smart Bookmark
Explore the docs »

View Demo · isabellart Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

isabella is a project that let's you write smart bookmarks in Rust inspired by bunny, a tool by facebook, and use it right from your browser. One of the projects i am doing while learning Rust programming Language.

Built With

• Rust
• Actix

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure you have Rust installed.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Installation

1. Clone the isabella

git clone https://github.com/SachinMaharana/isabella.git

2. Build the project

cargo build

3. Run the project.

cargo run

4. Visit localhost:8080/healthz to check if is running.
5. To test, go to localhost:8080/search?cmd=tw and you should be redirected to Twitter

Usage

TODO

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @iSachinMaharana - [email protected]

Project Link: https://github.com/SachinMaharana/isabella

Acknowledgements