https://github.com/juls0730/passport

A dashboard, similar to Homer by @bastienwirtz
https://github.com/juls0730/passport

dashboard fiber-framework golang handlebars homepage self-hosted sqlite toolbox zqdgr

Last synced: 5 days ago
JSON representation

A dashboard, similar to Homer by @bastienwirtz

• Host: GitHub
• URL: https://github.com/juls0730/passport
• Owner: juls0730
• License: bsl-1.0
• Created: 2024-11-11T06:19:02.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-09T12:01:19.000Z (about 2 months ago)
• Last Synced: 2024-12-09T13:18:59.517Z (about 2 months ago)
• Topics: dashboard, fiber-framework, golang, handlebars, homepage, self-hosted, sqlite, toolbox, zqdgr
• Language: Go
• Homepage:
• Size: 432 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Passport

Passport is a simple, fast, and lightweight web dashboard/new tab replacement.

> "I cant believe I've never broken it" - me

## Getting Started

![Screenshot 2024-11-11 at 00-20-06 Passport](https://github.com/user-attachments/assets/ba16da2f-fb84-4f45-827f-3de0af6626a0)

### Prerequisites

- [ZQDGR](https://github.com/juls0730/zqdgr)

- [Go](https://go.dev/doc/install)

- [sqlite3](https://www.sqlite.org/download.html)

- [TailwdinCSS CLI](https://github.com/tailwindlabs/tailwindcss/releases/latest)

### Usage

1. Clone the repository

2. Configure the `.env` file, an example is provided in the `.env example` file

   - The `OPENWEATHER_API_KEY` is required for the weather data to be displayed

   - The `OPENWEATHER_LAT` and `OPENWEATHER_LON` are required for the weather data to be displayed

   - The `PASSPORT_ADMIN_USERNAME` and `PASSPORT_ADMIN_PASSWORD` are required for the admin dashboard

   - The `PASSPORT_SEARCH_PROVIDER` is the search provider used for the search bar, %s is replaced with the search query

3. Run `zqdgr build` to build the project

4. Deploy `passport` to your web server

5. profit

### Adding links and categories

The admin dashboard can be accessed at `/admin`, you will be redirected to the login page if you are not logged in, use the credentials you configured in the `.env` file to login. Once logged in you can add links and categories.

## License

This project is licensed under the BSL-1.0 License - see the [LICENSE](LICENSE) file for details