Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/exlibris-fed/exlibris

activitypub books federated golang reading

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/exlibris-fed/exlibris
Owner: exlibris-fed
License: mit
Archived: true
Created: 2020-02-27T14:26:00.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-02-24T15:50:12.000Z (over 2 years ago)
Last Synced: 2024-04-13T14:06:05.869Z (7 months ago)
Topics: activitypub, books, federated, golang, reading
Language: Go
Size: 21 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 46
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # exlibris

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)

`exlibris` is a social network dedicated to tracking and discussing what you're reading.

This will be filled out more once we have a more fleshed out project.

## Developing

exlibris is written in [Vue.js](https://vuejs.org/) and [go](https://golang.org/), with ActivityPub support coming from [go-fed](https://github.com/go-fed/activity). It uses [postgreSQL](https://postgresql.org/) as a database, though you don't need it installed. [Docker](https://www.docker.com/) is required to build locally.

### Environment files

You need to provide environment variables for the database, app (Vue) and api (go). Copy any file ending in `.env.dist` to `.env` (ie `app.env.dist` to `app.env`) and fill in as necessary.

### Hot reload

To start a development server:

```bash

make run-local

```

This will start both the back- and front-ends with hot reloading, so making a change in a file will automatically recompile.

## History

exlibris was created during the 2020 employee hackathon at [ACV Auctions](https://acvauctions.com) and is being actively developed by its creators. We'd love to have your help too!