search

ZhichGaming / Project-Raphael

An AI-powered multi-platform app that can interact with the filesystem and execute commands. Built as our secondary 4 final CS project.
GNU General Public License v3.0
4 stars 3 forks source link

readme

Contributors Forks Stargazers Issues GPL-3.0 License


Logo

Project Raphael

An AI-powered multi-platform app that can interact with the filesystem and execute commands. Built as our secondary 4 final CS project.
Report Bug · Request Feature · Discord

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project is in developpment and the description may not conform to the final product.

Project Raphael aims to be an AI application with features like image processing, conversation, terminal access, etc. The application can be installed locally, using a local AI or a remote server, utilizing web requests for communication. The goal is a versatile AI application, with continuous development beyond the project deadline of the end of the school year. Contributions are welcome, whether it is for enhancing existing features or integrating third-party AIs.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple steps. Contact us through discord for more information.

Prerequisites

Running

  1. Navigate to the folder you want the project to be located in using terminal.
  2. Run git clone https://github.com/ZhichGaming/Project-Raphael.git.
  3. Run npm i to install dependancies.
  4. Install VScode extensions:
    1. Tauri
    2. rust-analyzer
  5. Run npm run tauri dev.

Building

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the GNU General Public License v3.0 (GPL-3.0). See LICENSE for more information.

(back to top)

Contact

You can contact us through Discord or through email if you'd like.

Project Link: https://github.com/ZhichGaming/Project-Raphael

(back to top)

Acknowledgments

(back to top)