elfakiri2023/coolresume

README

Please note that this is a work in progress

Cool Resume

Craft, share, and showcase your professional story easily, saving time and hassle.

Technologies used:

Framework: Sveltekit
UI: Skeleton & Tailwind Css
Database: Cloudflare D1
Storage: Cloudflare R2
Hosting: Cloudflare Pages
CLI: Wrangler
Authentication: Lucia
ORM: Drizzle
Email sending: MailChannels
Data validation: Zod
Captcha: Turnstile

Getting Started

1. Clone the Repository

git clone https://github.com/elfakiri2023/coolresume.git
cd coolresume

2. Install Dependencies

npm install

3. Configure Cloudflare

Login:
```
wrangler login
```
Follow the prompts to log in to your Cloudflare account.
Create Project
```
wrangler pages project create coolresume
```
You can create a project via the Cloudflare dashboard or using the CLI.
Create Database:
```
wrangler d1 create coolresume_db
```
You can create a database via the Cloudflare dashboard or using the CLI.
Create R2 Bucket:
```
wrangler r2 bucket create coolresume-bucket
```
You can create a bucket via the Cloudflare dashboard or using the CLI.

4. Configure Wrangler

Copy wrangler.toml.example to wrangler.toml and update it with your database name, ID, and R2 bucket name.

5. Generate Turnstile Keys

Navigate to Turnstile section in your Cloudflare dashboard. Add your site and obtain the Site Key and Secret Key provided.

6. Configure Environment Variables

Modify the environment variables by copying .env.example to .env and updating it with necessary details

TURNSTILE_SECRET_KEY Turnstile secret key
PUBLIC_TURNSTILE_SITE_KEY Turnstile site key
PUBLIC_CDN_URL The CDN url used for displaying stored images (either a custom domain or the one provided with Cloudflare R2).
CLOUDFLARE_ACCOUNT_ID Go to Workers & Pages -> Overview -> copy Account ID from the right sidebar.
CLOUDFLARE_DATABASE_ID Open D1 database you want to connect to and copy Database ID.
CLOUDFLARE_D1_TOKEN Go to My profile -> API Tokens and create token with D1 edit permissions.

7. Setup the Database

run

npm run db:gen

then run

npm run db:mig:local

and to view and edit the Database in your browser using Drizzle Studio, run

db:studio:local

7. Local Development

To bind the D1 database and R2 bucket locally, run:

npm run proxy

In another command line window, run:

npm run dev

8. Deployment

For database migration to production, run

db:mig:prod

Then, deploy your project by running

npm run deploy

TO-DO

✅ Send email with MailChannels
⬜️ Social login (Google, Github)
⬜️ About section (Email, Location, Phone number ..)