sebcar/snowbodyknows

A secret santa wishlist builder

Snowbody Knows

A secret santa wishlist builder.

I’m building a secret Santa app for my family to during the holidays. A user can build a wishlist and everybody else can check things off of it without the user being able to see.

Contributing

There are some issues to get started with, but I'm open to any ideas! I'd recommend you create an issue first, before starting work, just to get confirmation that I'm not wasting your time.

Installation

Step one is to clone this repo:

git clone https://github.com/imacrayon/snowbodyknows
cd snowbodyknows

If you're looking to get started quickly we recommend using our Docker setup. If you'r using something like Herd or Valet on your machine you can follow our basic setup steps.

Docker Setup

1. With Docker installed on your machine, start up a docker container:

./vendor/bin/sail up

Check the Laravel Sail documentation for command line details.

Basic Setup

1. Install PHP dependencies:

   composer install

2. Install NPM dependencies:

   npm install

3. Build assets:

   npm run dev

4. Create a SQLite database: (You can also use another database [MySQL, Postgres], simply update your configuration accordingly)

   touch database/database.sqlite

5. Copy the environment config example and rename it to .env:

   cp .env.example .env

6. Generate an application key:

   php artisan key:generate

7. Run database migrations:

   php artisan migrate

8. Start the built-in web server:

   php artisan serve

You're ready to go! Visit http://127.0.0.1:8000 in your browser.