Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/odinapp/odin

Open-source, cross-platform, hassle-free file sharing with AES-256 encryption made with Flutter & Dart.
https://github.com/odinapp/odin

cross-platform dart file-sharing file-upload flutter

Last synced: about 2 months ago
JSON representation

Open-source, cross-platform, hassle-free file sharing with AES-256 encryption made with Flutter & Dart.

Host: GitHub
URL: https://github.com/odinapp/odin
Owner: odinapp
License: gpl-3.0
Created: 2021-11-13T08:15:12.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2022-09-18T16:05:53.000Z (over 2 years ago)
Last Synced: 2024-08-03T14:09:04.088Z (5 months ago)
Topics: cross-platform, dart, file-sharing, file-upload, flutter
Language: Dart
Homepage:
Size: 5.49 MB
Stars: 124
Watchers: 6
Forks: 11
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

Odin

⚡ Open source easy file sharing for everyone. ⚡

Cross-platform hassle-free file sharing with AES-256 encryption made with Flutter & Dart.

Getting Started •
Roadmap •
Releases

Open source easy file sharing for everyone.

Demo

https://user-images.githubusercontent.com/42910433/143038817-cb935815-aea7-41c1-8b56-131cb99b0a20.mp4

## Built With

* [Flutter](https://flutter.dev/)

* [Dart](https://dart.dev/)

## Getting Started

To build on MacOS or Windows, please follow these simple steps.

**Step 1:**

```shell
git clone https://github.com/odinapp/odin.git
```

**Step 2:**

```shell
cd odin
```
```shell
touch .env
```
```shell
echo 'GITHUB_TOKEN=**GITHUB_ACCESS_TOKEN**' >> .env
```
```shell
echo 'GITHUB_USERNAME=**GITHUB_USERNAME**' >> .env
```
```shell
echo 'GITHUB_TOKEN=**GITHUB_TOKEN**' >> .env
```

>
>
> These environment variables are required as Odin uses a GitHub Repo to store the uploaded files.
> You may read GitHub docs to access these secrets.

**Step 3:**

Follow the instructions [here](https://flutter.dev/docs/get-started/install) to install Flutter. As Odin uses the `stable` channel, you need to switch the channel if you are on `dev` or `beta` channels. Just type:

```shell
flutter channel stable
```

**Step 4:**

You should enable the specified platform first if you don't enable it before and then select the desktop device.
```shell
# for windows
flutter config --enable-windows-desktop

# for macos
flutter config --enable-macos-desktop

# for linux
flutter config --enable-linux-desktop
```

**Step 5:**

To run the app just type these commands in terminal or use the Run and Debug option from your editor of choice.
```shell
flutter pub get
flutter run
```
## Roadmap

If you'd like to propose a feature, submit an issue [here](https://github.com/odinapp/odin/issues).

## Releases

Please see the [releases tab](https://github.com/odinapp/odin/releases) for more details about the latest release.

## Contributing
First off, thanks for visiting Odin's repo and taking your time to read this doc.
Any contributions you make are **greatly appreciated**. Please look at [CONTRIBUTING.md](https://github.com/odinapp/odin/blob/main/doc/CONTRIBUTING.md) for details.

## What is Odin?
Odin began as what most projects start as "A weekend project". Originally, we wanted to develop a cross-platform, open-source file-sharing platform that was faster and easier than sharing files over chat services or data cables.
We wanted to develop and prototype the project as quickly as possible. The result was an MVP that was ready in just a few hours because we used Flutter.

> Fun Fact: The app icon resembles the helmet of the god Odin from Norse mythology. It also resembles a free-flying bird, which indicates our feelings while developing this with Flutter😊.

## License

Distributed under the GPL-3.0 License. See `LICENSE` for more information.

## Contributers

### If you made it here, thanks for your support. You can show more support by starring this repo. See ya! 👋