Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quotepedia/web
Quotepedia's web client
https://github.com/quotepedia/web
api frontend i18n javascript jwt nitro openapi pnpm quotepedia responsive solid-start solidjs tailwind typescript vinxi vite web
Last synced: 12 days ago
JSON representation
Quotepedia's web client
- Host: GitHub
- URL: https://github.com/quotepedia/web
- Owner: quotepedia
- License: mit
- Created: 2024-09-21T16:55:05.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T20:18:54.000Z (19 days ago)
- Last Synced: 2024-10-21T00:50:37.448Z (18 days ago)
- Topics: api, frontend, i18n, javascript, jwt, nitro, openapi, pnpm, quotepedia, responsive, solid-start, solidjs, tailwind, typescript, vinxi, vite, web
- Language: TypeScript
- Homepage:
- Size: 1.04 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Quotepedia
A library of inspiration that you create yourself.
## 🗝️ Features
* Comming soon…
## 🗺️ Roadmap
To see the current and future tasks for this project, please navigate to the [projects](https://github.com/quotepedia/web/projects) tab.
## 📦 Building
To start, open a command prompt and follow these instructions:
### Prerequisites
To run this web app on your local machine, install the following:
- [pnPm](https://pnpm.io/installation): Fast, disk space efficient package manager.
### Step 1 — Install dependencies
```sh
pnpm i
```
### Step 2 — Configure the environment
Create `.env` file in the root directory with the following contents:
```properties
VITE_API_URL="http://127.0.0.1:8000/"
# Must be at least 32 characters long
# Generate with `head -c32 /dev/urandom | base64`
VITE_SESSION_SECRET="9aCbXMa1%pJcCMubS^HuprJ5YjSY5"
# Make sure to enable this when have an SSL (HTTPS) certificate
VITE_SECURE_COOKIES=
```
These settings are suitable for the most who want to run the app **locally**. Here's a more detailed and advanced explanation of each configuration option:
| Option | Description | Type | Default | Required |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------- | -------- |
| `VITE_API_URL` | URL of the API server that the web app will interact with. | `string` | | ✓ |
| `VITE_SESSION_SECRET` | Private key used to encrypt sessions. **Must be at least 32 characters long**. | `string` | | ✓ |
| `VITE_SECURE_COOKIES` | Determines whether the cookies sent to browser should be marked as [secure](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#block_access_to_your_cookies). Make sure to enable this when have an SSL (HTTPS) certificate. | `boolean` | `false` | ✗ |
> [!NOTE]
> You can also browse all available configuration options [here](./src/global.d.ts).
### Step 3 — Run the app
To build and start the app, just execute the following command:
```sh
pnpm serve
```
The setup is done. Enjoy using this! 🎉
### FAQ
#### Error | Uncaught Client Exception
Make sure `VITE_SECURE_COOKIES` is not set to `true` or you have a valid SSL (HTTPS) certificate.
#### Error: Empty password
`VITE_SESSION_SECRET` Configuration option is not set. Make sure to re-read the [step 2](#step-2--configure-the-environment) and clear browser cookies.
> [!NOTE]
> You may also need to **re-build** the web app using `pnpm serve` or `pnpm build` to include newly configured options in `.env`.
## ❤️ Acknowledgments
See the [contributors](https://github.com/quotepedia/web/contributors) who participated in this project and the [dependencies](https://github.com/quotepedia/web/network/dependencies) used.
## 📜 License
This project is licensed under the **MIT** — see the [`LICENSE.md`](LICENSE.md) file for details.