Skip to content

Latest commit

 

History

History
156 lines (118 loc) · 4.72 KB

readme.md

File metadata and controls

156 lines (118 loc) · 4.72 KB
Raw

preview

Care.tv

Care.tv makes it really easy to enjoy movies or watch TV shows with the people you care about, no matter how far!

Works for mobile, tablet, and desktop screens. Does not work with iOS at the moment.

API Setup

You will have to install these dependencies: MySQL 5.7, php >=7.2 along with Composer, and ngrok (Optional)

  • Move to the api folder.
cd api
  • Install the dependencies
composer install
  • Copy .env.example to .env, and setup your environment config. Particularly, the database credentials (DB_*).
cp .env.example .env
  • Open up .env, then configure the cdn url & request access code
# Where your media is stored
APP_CDN=https://your-digital-ocean-cdn.sgp1.cdn.digitaloceanspaces.com/

# This is used for the registration, but you can leave empty.
APP_REQUEST_ACCESS_CODE=
  • Publish unique key for Laravel.
php artisan key:generate
  • Run the migrations. Don't forget to store the client id and secret output from running php artisan passport:client.
php artisan migrate
php artisan db:seed && php artisan db:seed --class=ShowSeeder
php artisan passport:install
php artisan passport:client --password

This installs all required tables and creates a user with the following credentials: [email protected] (email) / admin (password)

Make sure to replace <YOUR PASSWORD HERE> with your desired password.

  • Setup Pusher by logging in to its dashboard, and creating a client. When you're done, open up .env, and change the following with the details provided by Pusher:
PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=
  • You should be good to go. Run the command below then head over to http://localhost:8000
php artisan serve

API Setup: Enable Active Presence Locally (Optional)

Active Presence is a feature that lets you know if a user invited to a room is active or not.

If not enabled, users will simply be inactive by default.

  • If you're setting this up locally, setup ngrok, then point it to port 8000 (port used by php artisan serve).
ngrok http 8000

  • Open up Pusher, head over to the Web Hooks tab.

  • Either paste the api's public url or ngrok's generated url (e.g., http://9542199e.ngrok.io) to the Webhook URL input.

  • Select Presence for the Event Type, then press Add.

Front-end setup

You will need npm >=6 and Node.js >=11.

  • Move to the ui folder
cd ui
  • Install the dependencies
npm i
  • Copy .env.example to .env, and setup your environment config. Update the API_CLIENT_* based on the output from php artisan passport:client --password (refer to instructions above).
cp .env.example .env
  • Start Parcel, and you're all good.
npm start

It should open up to your a new browser window shortly. However, if it doesn't, you can manually open http://localhost:3000.

You can either register or login with the following credentials: [email protected] (email) / admin (password)

Deployment

The API and front-end are deployed separately.

API

Currently, Care.tv is deployed on Laravel Forge. If you follow the API setup instructions properly, things should work out of the box.

  • Initially, make sure to setup Laravel Passport:
php artisan passport:install
php artisan passport:client --password
  • Make sure to also change the default admin ceredentials as soon as possible:
php artisan tinker
$user = User::first();
$user->password = Hash::make('<YOUR PASSWORD HERE>');
$user->save();
  • Lastly, make sure to setup active presence - can also be seen above.

Front-end

The web interface is hosted on Netlify for free.

  • Set the root folder to ui; the public folder to dist.
  • Set the environment config accordingly.
  • For the build command:
npm run build

Custom API Commands

# Lists the most recent parties since 3 days ago
php artisan app:list-pt
# Lists the most recent parties since 5 days ago
php artisan app:list-pt 5

# Lists the last 15 registrations
php artisan app:list-users
# Lists the last 30 registrations
php artisan app:list-users 30

Attribution