https://github.com/srph/pulse
Pulse is an annual bullet journal that lets you keep track of your goals.
https://github.com/srph/pulse
laravel parcel react
Last synced: about 1 year ago
JSON representation
Pulse is an annual bullet journal that lets you keep track of your goals.
- Host: GitHub
- URL: https://github.com/srph/pulse
- Owner: srph
- Created: 2019-03-25T15:05:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:10:52.000Z (over 3 years ago)
- Last Synced: 2025-03-18T12:03:56.044Z (about 1 year ago)
- Topics: laravel, parcel, react
- Language: TypeScript
- Homepage: https://pulse.kierb.com
- Size: 3.8 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 45
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## Pulse
Pulse is an annual bullet journal to help you track your progress. Inspired by [@weelui](https://twitter.com/weelui/status/1082070518520414209).
## API Setup
You will have to install these dependencies: [MySQL `5.7`](https://dev.mysql.com/downloads/mysql/5.7.html), [php `>=7.2`](https://thishosting.rocks/install-php-on-ubuntu/) along with [Composer](https://getcomposer.org/).
- Move to the `api` folder.
```
cd api
```
- Install the dependencies
```bash
composer install
```
- Copy `.env.example` to `.env`, and setup your environment config. Particularly, the database credentials (`DB_*`).
```bash
cp .env.example .env
```
- Bootstrap the application. Don't forget to store the client id and secret output from running `passport:client`.
```bash
php artisan migrate
php artisan passport:install
php artisan passport:client --password
```
- You should be good to go
```bash
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`.
```bash
cp .env.example .env
```
- Start Parcel, and you're all good.
```bash
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:
```bash
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
- [Louie (@leewui)](https://twitter.com/weelui/status/1082070518520414209) for the idea.
- [DrawKit](https://www.drawkit.io/illustrations/drawing-woman-colour) for the free illustrations pack.