-
Notifications
You must be signed in to change notification settings - Fork 629
feat: Complete refactoring to a self-hosted, rebranded application #94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
xifanezz
wants to merge
2
commits into
cloudflare:main
Choose a base branch
from
xifanezz:feat/remove-cloudflare-and-rebrand
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Local Development Setup | ||
|
||
This document provides instructions for setting up and running the application in a local development environment. This setup uses a standard Node.js server and does not require any Cloudflare-specific services. | ||
|
||
## Prerequisites | ||
|
||
- Node.js (v18 or later) | ||
- npm or bun | ||
|
||
## Installation | ||
|
||
1. **Install dependencies:** | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
or | ||
|
||
```bash | ||
bun install | ||
``` | ||
|
||
2. **Set up the database:** | ||
|
||
This project uses a local SQLite database. To set up the database and apply migrations, run the following command: | ||
|
||
```bash | ||
npx drizzle-kit push | ||
``` | ||
|
||
## Authentication Setup (Clerk) | ||
|
||
This project uses [Clerk](https://clerk.com/) for authentication. To get started, you will need to create a free Clerk account and set up a new application. | ||
|
||
1. **Create a Clerk Application:** | ||
- Go to the [Clerk Dashboard](https://dashboard.clerk.com/) and create a new application. | ||
- Give your application a name and choose your preferred sign-in options. | ||
|
||
2. **Get API Keys:** | ||
- In your Clerk application dashboard, navigate to **API Keys**. | ||
- You will need the **Publishable key** and the **Secret key**. | ||
|
||
3. **Configure Environment Variables:** | ||
- Create a new file named `.env` in the root of the project by copying the `.env.example` file. | ||
- Open the `.env` file and add the keys you obtained from the Clerk dashboard: | ||
|
||
```env | ||
CLERK_SECRET_KEY="YOUR_CLERK_SECRET_KEY" | ||
CLERK_PUBLISHABLE_KEY="YOUR_CLERK_PUBLISHABLE_KEY" | ||
``` | ||
|
||
## Running the Application | ||
|
||
1. **Start the backend server:** | ||
|
||
To start the backend server, run the following command. This will start the Hono application on a Node.js server, which will be available at `http://localhost:3000` by default. | ||
|
||
```bash | ||
npm run dev:node | ||
``` | ||
|
||
2. **Start the frontend development server:** | ||
|
||
In a separate terminal, start the Vite frontend development server: | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
The frontend will be available at `http://localhost:5173`. | ||
|
||
## Environment Variables | ||
|
||
The application is configured using a `.env` file. See the `.env.example` file for a full list of available options. | ||
|
||
``` | ||
# Clerk Authentication | ||
CLERK_SECRET_KEY= | ||
CLERK_PUBLISHABLE_KEY= | ||
|
||
# Application | ||
PORT=3000 | ||
CUSTOM_DOMAIN=localhost:5173 | ||
NODE_ENV=development | ||
``` |
Large diffs are not rendered by default.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import { defineConfig } from 'drizzle-kit'; | ||
|
||
export default defineConfig({ | ||
schema: './worker/database/schema.ts', | ||
out: './migrations', | ||
dialect: 'sqlite', | ||
driver: 'better-sqlite', | ||
dbCredentials: { | ||
url: './data/sqlite.db', | ||
}, | ||
verbose: true, | ||
strict: true, | ||
}); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
log-2025-10-3_20-54-29.559.txt