Skip to content

quotepedia/web

Repository files navigation

App icon

Quotepedia

A library of inspiration that you create yourself.

Dependencies Badge Workflow Status Badge API Version Badge

🗝️ Features

  • Comming soon…

🗺️ Roadmap

To see the current and future tasks for this project, please navigate to the 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: Fast, disk space efficient package manager.

Step 1 — Install dependencies

pnpm i

Step 2 — Configure the environment

Create .env file in the root directory with the following contents:

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^HuprJ5YjS&#xY5"

# 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. Make sure to enable this when have an SSL (HTTPS) certificate. boolean false

Note

You can also browse all available configuration options here.

Step 3 — Run the app

To build and start the app, just execute the following command:

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 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 who participated in this project and the dependencies used.

📜 License

This project is licensed under the MIT — see the LICENSE.md file for details.