Lore

The shared, single source of truth for everything.

Table of Contents

• What is Lore
• Where is the data stored
• Setup Flutter
• Clone the Repository
• Install dependencies
• Run the App
• Deploy the Web App to Firebase
• Add localizations
• Contributing
• License

What is Lore?

Lore is a repository of knowledge. It is a shared, single source of truth for anything based on the md5sum of the file. It is a place for people to leave comments or notes on any file.

Where is the data stored?

At present, the plan is to store the data in Supabase. In the future data could be hosted in a managed or on-prem db.

Setup Flutter

Make sure you have Flutter installed on your machine. If not, follow the Flutter installation guide: Flutter Installation Guide

Clone the Repository

Use the following command to clone the Lore repository:

git clone https://github.com/BlakeBarrett/Lore.git

Install dependencies

After cloning the repository you will need to install the dependencies used by Lore. To do so, run:

flutter pub get

Run the App

Navigate to the Lore project directory and run the app:

cd Lore
flutter run

This command will build and run the app on your default device or emulator.

Deploy the Web App to Firebase

flutter build web --release --no-tree-shake-icons
firebase deploy

Live Web app (nightly builds)

Firebase will deploy the web artifacts to the following URL, also where the latest build can be evaluated: https://lore-5b6b8.web.app/

Add localizations

To add a new localization, follow the instructions in the flutter_localizations package documentation.
Then generate the AppLocalizations file by executing the command below in the terminal:

flutter gen-l10n

Contributing

Contributions are welcome! Please read the Contribution Guidelines before making a contribution.

License

This project is licensed under the BSD 3-Clause License.

Screen Shots