Skip to content

Commit

Permalink
Added LICENSE and README
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkoKuzmanovic committed Aug 15, 2024
1 parent a64077f commit 9fe788b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 3 deletions.
7 changes: 7 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2024 Darko Kuzmanovic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
39 changes: 36 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,40 @@
# Tauri + Vanilla
# Lemi AI

This template should help get you started developing with Tauri in vanilla HTML, CSS and Javascript.
Lemi AI is a super simple desktop application that serves as a web wrapper for a Custom GPT specializing in Helpdesk Customer Support. Made using Tauri and Rust.

## Features

- Seamless integration of a Custom GPT for Helpdesk Customer Support
- Desktop application with web technologies
- Cross-platform compatibility (Windows, macOS, Linux)
- Refresh functionality for easy content updates

## Development

This project uses Tauri with vanilla HTML, CSS, and JavaScript. To get started with development:

1. Ensure you have Rust and Node.js installed on your system.
2. Clone this repository.
3. Run `npm install` to install dependencies.
4. Use `npm run tauri dev` to start the development server.

## Building

To build the application:

1. Run `npm run tauri build`
2. Find the built application in the `src-tauri/target/release` directory

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
- [VS Code](https://code.visualstudio.com/) with the following extensions:
- [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode)
- [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

[MIT License](LICENSE.md)

0 comments on commit 9fe788b

Please sign in to comment.