Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bookshelves-project/bookshelves-front

Bookshelves projects to display epubs
https://github.com/bookshelves-project/bookshelves-front

books epub epubs nuxt nuxt3 nuxtjs ssr tailwindcss typescript vue vue3

Last synced: about 1 month ago
JSON representation

Bookshelves projects to display epubs

Host: GitHub
URL: https://github.com/bookshelves-project/bookshelves-front
Owner: bookshelves-project
License: bsd-2-clause
Created: 2021-03-15T10:18:20.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-12-23T12:42:03.000Z (about 1 year ago)
Last Synced: 2023-12-23T19:13:38.432Z (about 1 year ago)
Topics: books, epub, epubs, nuxt, nuxt3, nuxtjs, ssr, tailwindcss, typescript, vue, vue3
Language: Vue
Homepage: https://bookshelves.ink
Size: 8.73 MB
Stars: 10
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Bookshelves · Front 

[![nuxt](https://img.shields.io/static/v1?label=Nuxt&message=v3.x&color=00C58E&style=flat-square&logo=nuxt.js&logoColor=ffffff)](https://nuxtjs.org/)

[![nuxt-ssr](https://img.shields.io/static/v1?label=Designed%20to%20be&message=SSR&color=00C58E&style=flat-square&logo=nuxt.js&logoColor=ffffff)](https://nuxtjs.org/docs/concepts/server-side-rendering/)

[![tailwindcss](https://img.shields.io/static/v1?label=Tailwind%20CSS&message=v3.x&color=38B2AC&style=flat-square&logo=tailwind-css&logoColor=ffffff)](https://tailwindcss.com/)

[![node](https://img.shields.io/static/v1?label=NodeJS&message=v16.x&color=339933&style=flat-square&logo=node.js&logoColor=ffffff)](https://nodejs.org/en)

[![pnpm](https://img.shields.io/static/v1?label=pnpm&message=v7.x&color=F69220&style=flat-square&logo=pnpm&logoColor=ffffff)](https://pnpm.io)

- 📀 [**bookshelves-project**](https://github.com/bookshelves-project) : Bookshelves repository

- 💻 [**bookshelves.ink**](https://bookshelves.ink): demo

- 📚 [**documentation.bookshelves.ink**](https://bookshelves-documentation.netlify.app): documentation, if this link not work, you can check doc on [this repository](https://github.com/bookshelves-project/bookshelves-doc)

Works with [documentation](https://nuxtjs.org).

## Commands

To upgrade

```bash

npx nuxi-edge@latest upgrade --force // Automated

```

Manual: Bump `nuxt` dependency to `3.0.0-rc.13` and then use `npx nuxi-edge@latest cleanup` to cleanup any local caches

_OR_

Bump `nuxt` dependency to `npm:nuxt3@latest` and then use `npx nuxi-edge@latest cleanup` to cleanup any local caches

## **Setup**

Setup local on  with  API

Create `.env`

```bash

cp .env.example .env

```

Node.js dependencies

```bash

pnpm i

```

Local serve

```bash

pnpm dev

```

### _Update API_

Update `.env` on `API_URL` to use local API

```yml

API_URL=http://localhost:8000

```

## **Production in SSR**

Update `.env`

```yml

BASE_URL=https://bookshelves.ink

API_URL=https://bookshelves.ink

```

Setup build

```bash

pnpm build

```

Launch server in SSR

```bash

pnpm start

```

For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).