Vision Quest

This is a simple and attractive vision board creator. It generates a personal vision board you can run in any browser. It's free, open source, and works excellently.

If you're unfamiliar with the concept of a vision board, it's a series of photos for each area of your life. You can use it for inspiration, motivation, and visualisation. Regardless of whether you believe in the law of attraction or not, it's still a powerful tool.

I made this project because I was dissatisfied with other vision board creation software, and wanted something that would meet my needs. It's open source so anyone can enjoy it.

✨ Features

Easy to use—add photos to subfolders in src/photos/board, and it will automatically generate the vision board
Beautiful, simple, and responsive design
High performance and statically generated, with super fast load times (it's using Gatsby)
Self-host anywhere or run locally on your device
High resolution, optimised, and zoomable images with blurred placeholders
Progressive Web App (works offline + installable on devices)
Free and open source
Private—you own your data
Customisable avatar/name

🚀 Quick start

Fork the repository.

Fork this repository on GitHub to create your own vision board.
Install the dependencies.

Install the project's dependencies with Yarn:
```
yarn install
```
Add photos to your vision board.

a) Create a subfolder for each section of your vision board, such as src/photos/board/Health & Fitness. The name of the subfolder will be used as a title for the section on the vision board, e.g "Health & Fitness"

b) Add photos to each subfolder. The filename of each photo will be used as its tooltip/alt text.

Supported image formats: .jpg, .jpeg, .png, and .webp

Some website suggestions for finding high quality, interesting photos are Unsplash, Pexels, and Pinterest.
Configure the environment variables.

Create a .env file using .env.example:
```
cp .env.example .env
```
Then edit .env in your editor with your preferred settings.

Note if GATSBY_SENTRY_DSN is not set, Sentry will be disabled.
Add your avatar.

Add a headshot of yourself to src/images/avatar.jpg. It will add this photo to the top of the vision board.
Start the development server.
```
yarn develop
```
The server will run on http://localhost:8000.

🚀 Deployment

You can build the vision board and deploy it manually yourself:

yarn build
yarn serve

Or you can deploy your vision board with one click on Netlify:

If you deploy it online, I suggest adding password protection for privacy. Netlify has an option for this, as do most cloud services.

Otherwise you can run it locally on your device with the development server (or yarn build and yarn serve).

🛠️ Utility commands

Run Prettier:

yarn prettier
yarn prettier:fix # Fix errors

Run ESLint:

yarn lint
yarn lint:fix # Fix errors

Run TypeScript checking:

yarn typecheck

Remove node_modules, .cache, and public folders for regeneration:

yarn clean

👨‍💻 Tech stack

These are the primary technologies and libraries used in this project:

demeralde / vision-quest