pulse

Pulse is an annual bullet journal that lets you keep track of your goals.

Stars
5
View Code on GitHub Visit Website View on X
Ecosystems: TypeScript

Pulse

Pulse is an annual bullet journal to help you track your progress. Inspired by @weelui.

API Setup

You will have to install these dependencies: MySQL 5.7, php >=7.2 along with Composer.

  • 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
  • Bootstrap the application. Don't forget to store the client id and secret output from running passport:client.
php artisan migrate
php artisan passport:install
php artisan passport:client --password
  • You should be good to go
php artisan serve

Front-end setup

You will need npm >=5 and Node.js >=10.

  • 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.
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.

Deployment

The API and front-end are deployed separately.

API

Currently, Pulse is deployed on Laravel Forge. For the initial deployment, don't forget to run:

php artisan passport:install
php artisan passport:client --password

Front-end

The web interface is hosted on Netlify for free. Set the root folder to ui; the public folder to dist. For the build command:

npm run build

Attribution