Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukasalvarezdev/notion-database-to-invoice-pdf
Give me a Notion Database and I'll give you a beautiful invoice for your clients!
https://github.com/lukasalvarezdev/notion-database-to-invoice-pdf
react typescript
Last synced: about 2 months ago
JSON representation
Give me a Notion Database and I'll give you a beautiful invoice for your clients!
- Host: GitHub
- URL: https://github.com/lukasalvarezdev/notion-database-to-invoice-pdf
- Owner: lukasalvarezdev
- License: gpl-3.0
- Created: 2024-10-22T13:07:35.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T17:44:47.000Z (3 months ago)
- Last Synced: 2024-10-24T01:52:02.850Z (3 months ago)
- Topics: react, typescript
- Language: TypeScript
- Homepage: https://lukasalvarez.com
- Size: 293 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
# Notion Database to Beautiful Invoice PDF
## The Problem
When you are an independent contractor or freelancer, you need to keep track of the hours you
work per day and the tasks you do. You can use a Notion database to keep track of this
information, but you need to generate an invoice at the end of the month to send to your
clients. You can use tools like canva or google docs to create a beautiful invoice, but you need
to copy the information from the Notion database to the invoice manually.
## The Solution
This project is a simple web application that connects to a Notion database and displays the
information in a beautiful invoice format. You can generate a PDF of the invoice and send it to
your clients.
## Requirements
- Node.js
- Notion Account
- A Notion database with the following columns:
- Date (Date)
- Task (Text)
- Hours (Number)
## Setup
First, clone the repository and navigate to the project directory.
```sh
git clone lukasalvarezdev/notion-database-to-invoice-pdf
cd notion-database-to-invoice-pdf
```
Install the dependencies:
```sh
npm install
```
Copy the `.env.example` file to `.env` and replace with real values.
```sh
cp .env.example .env
```
Next, you need to get your Notion API key and database ID.
1. Go to [Notion Integrations](https://www.notion.so/my-integrations).
2. Click on `New Integration`.
3. Name your integration and click `Submit`.
4. Copy the `Internal Integration Secret` and paste it in the `.env` file as `NOTION_API_KEY`.
5. Go to the Notion page you want to use as a database, to get the database ID, check the URL.
It should look like `https://www.notion.so/{workspace}/{database_id}?v={version}`. Copy the
`database_id` and paste it in the `.env` file as `NOTION_DATABASE_ID`.
## Usage
Run the development server:
```sh
npm run dev
```
Open up [http://localhost:3000](http://localhost:3000) in your browser.
## Generate PDF
Just click on the `Generate PDF` button or press `Ctrl + P` to print the page and save it as a
PDF.
[license-badge]: https://img.shields.io/npm/l/mdx-bundler.svg?style=flat-square
[license]: https://github.com/lukasalvarezdev/notion-database-to-invoice-pdf/blob/main/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: https://makeapullrequest.com