-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,21 @@ | ||
| See demo at https://teatime-library.netlify.app/ | ||
| <h1 align="center"> | ||
| Teatime | ||
| </h1> | ||
|
|
||
| # Nuxt 3 Minimal Starter | ||
| <p align="center"> | ||
| Teatime is a fully static distributed library system powered by IPFS, SQLite and Github | ||
| </p> | ||
| <p align="center"> | ||
| <img src="https://github.com/user-attachments/assets/b233afd7-a389-43c9-b1ca-c6e1b7f67c79" height="300"> <br/> | ||
| A instance website is hosted on <a href="https://teatime-library.netlify.app/">Netlify</a> and <a href="https://teatime-library.github.io/teatime/">Github Pages</a> | ||
| </p> | ||
|
|
||
| Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. | ||
| # How does it work | ||
|
|
||
| ## Setup | ||
| ## Develop | ||
|
|
||
| Make sure to install the dependencies: | ||
| 1. Install the dependencies: `npm install` | ||
| 2. Run the server: `npm run dev` | ||
| 3. Navigate to `http://localhost:3000` | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm install | ||
|
|
||
| # pnpm | ||
| pnpm install | ||
|
|
||
| # yarn | ||
| yarn install | ||
|
|
||
| # bun | ||
| bun install | ||
| ``` | ||
|
|
||
| ## Development Server | ||
|
|
||
| Start the development server on `http://localhost:3000`: | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm run dev | ||
|
|
||
| # pnpm | ||
| pnpm run dev | ||
|
|
||
| # yarn | ||
| yarn dev | ||
|
|
||
| # bun | ||
| bun run dev | ||
| ``` | ||
|
|
||
| ## Production | ||
|
|
||
| Build the application for production: | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm run build | ||
|
|
||
| # pnpm | ||
| pnpm run build | ||
|
|
||
| # yarn | ||
| yarn build | ||
|
|
||
| # bun | ||
| bun run build | ||
| ``` | ||
|
|
||
| Locally preview production build: | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm run preview | ||
|
|
||
| # pnpm | ||
| pnpm run preview | ||
|
|
||
| # yarn | ||
| yarn preview | ||
|
|
||
| # bun | ||
| bun run preview | ||
| ``` | ||
|
|
||
| Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. | ||
| Check out the [Nuxt documentation](https://nuxt.com/docs/getting-started) for more information. |