A third-party Next.js client for the Harvest API V2, that helps you to manage the time tracking of your Harvest Account, while also giving you statistical feedback on how you spend your time.
Disclaimer: This project is not affiliated with Harvest
First, you will need a Harvest account to fully use this project. The free version will do fine.
To run the project, you need to have Node.js and its package manager NPM installed on your environment. The project also supports Docker 🐋
git clone https://github.com/vincentrohde/harvest-dashboard.git
cd ./harvest-dashboard
This will install the node_modules
and add the required .env
file.
./setup.sh
Now that you have everything in place, you can start the dashboard.
You can choose to run the dashboard using Node.js/ NPM. This
npm run dev
If you have Docker installed, you can also run the dashboard using Docker.
You can start the dashboard via:
npm run dev:up
Further down you will find an overview of all docker-related commands that are available in the project.
Now, the dashboard will be available via:
https://localhost:3000
If you want to use your own Harvest OAuth App, you can do so in the following way.
First, you have to go to the Developers section of your account. Here you will have to use the Create new OAuth2 application
button.
Now you will be directed to the setup page. On this page, you will have to set the Redirect URL
field, which is the URL of your application.
https://localhost:3000
https://www.yourwebsite.com
Once everything is set, hit Create application
.
Finally, you will arrive at the detail page of your OAuth App. The parameter Client ID
will be required in your .env
file.
When you have created your own OAuth App, you will have to update your .env
file.
OAUTH_APP_ID={ the Client ID of your OAuth App }
If you want to host the dashboard there are two options available to you.
This option is recommended if you use a hoster such as (Heroku, Cloudflare, etc.). They will allow you to automatically deploy on pushes to GitHub and most often host personal projects for free.
You are able to get a static version of the dashboard by running.
npm run production
This will return you all production-ready files in the ./out
directory. This will be enough for most of these hosters, since they are able to specifically deal with Nexct.js projects.
If you want to run a server on your own, you can then serve your static files using the server provided by Next.js. To do so, just run
npm run start
If you are hosting on an actual server or virtual machine, the recommended option is to use Docker for the production version of your dahsboard. This will make deployment much easier, since the setup for you is only minimal (ie. installing Docker and NPM on your environment)
Once, Docker is installed on your environment you can run
npm run prod:up
Now a static version of your dashboard will be served, using an Nginx Server. It's available under
https://0.0.0.0 and https://localhost
The following commands are available to you, when using Docker.
Cmd | Description |
---|---|
dev:install | Install the development container |
dev:up | Run and install the development container |
dev:down | Turn off the development container |
dev:uninstall | Uninstall the development container |
prod:install | Install the production container |
prod:up | Run and install the production container. Files are served using an NGINX server |
prod:down | Turn off the production container |
prod:uninstall | Uninstall the production container |