Thanks to visit codestin.com
Credit goes to github.com

Skip to content

maconprograms/Sink

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sink Project

Overview

This project is deployed at 10ksb.link using Cloudflare Pages.

Project Setup

Local Development Setup

  1. Clone the repository:
git clone https://github.com/maconprograms/Sink.git
cd Sink
  1. Environment Variables:
  • Copy .env.example to create your local .env file:
cp .env.example .env
  • Update the .env file with your local development values
  • The .env file is gitignored to keep sensitive data secure

Environment Variables Management

Local Development

  • All environment variables are stored in the .env file
  • The .env.example file serves as a template and documents required variables
  • Never commit the actual .env file to the repository

Production (Cloudflare)

  • Environment variables for production are managed through the Cloudflare Pages dashboard
  • To add/modify production variables:
    1. Go to Cloudflare Pages dashboard
    2. Select the "Sink" project
    3. Navigate to Settings > Environment variables
    4. Add or update variables as needed

Deployment

The project is deployed on Cloudflare Pages with the following setup:

  1. Domain Configuration:
  • Primary domain: 10ksb.link
  • Cloudflare Pages URL: sink-e99.pages.dev
  1. Deployment Process:
  • Automatic deployments are triggered by pushes to the master branch
  • Each deployment creates a unique preview URL
  • Production deployments are served from the main domain (10ksb.link)

Development Workflow

  1. Pull latest changes:
git pull origin master
  1. Make your changes locally

  2. Commit and push changes:

git add .
git commit -m "Your descriptive commit message"
git push origin master
  1. Cloudflare will automatically deploy your changes

Project Structure

Sink/
├── .editorconfig      # Editor configuration
├── .env.example       # Template for environment variables
├── .github/           # GitHub configuration files
├── .gitignore        # Git ignore configuration
├── .vscode/          # VSCode configuration
├── assets/           # Static assets
├── components/       # Vue components
├── docs/            # Documentation files
├── layouts/         # Nuxt layouts
├── middleware/      # Nuxt middleware
├── pages/           # Vue pages
├── public/          # Public static files
├── schemas/         # Data schemas
├── scripts/         # Utility scripts
├── server/          # Server-side code
├── utils/           # Utility functions
├── app.config.ts    # App configuration
├── app.vue          # Main Vue app file
├── nuxt.config.ts   # Nuxt configuration
├── package.json     # Project dependencies
├── tailwind.config.js # Tailwind CSS configuration
├── tsconfig.json    # TypeScript configuration
└── wrangler.toml    # Cloudflare configuration

Local Development Setup

  1. Clone the repository:
git clone https://github.com/maconprograms/Sink.git
cd Sink
  1. Install dependencies:
pnpm install
  1. Environment Variables:
  • Copy .env.example to create your local .env file:
cp .env.example .env
  • Update the .env file with your local development values
  • The .env file is gitignored to keep sensitive data secure

Development Workflow

  1. Start the development server:
pnpm dev
  1. Make your changes locally

  2. Before committing, ensure:

  • Code follows the project's ESLint rules
  • All tests pass (if applicable)
  • Changes are properly documented
  1. Commit and push changes:
git add .
git commit -m "Your descriptive commit message"
git push origin master

Production Deployment (Cloudflare Pages)

The project is deployed on Cloudflare Pages with the following setup:

  1. Domain Configuration:
  • Primary domain: 10ksb.link
  • Cloudflare Pages URL: sink-e99.pages.dev
  1. Environment Variables:
  • Managed through Cloudflare Pages dashboard
  • To add/modify production variables:
    1. Go to Cloudflare Pages dashboard
    2. Select the "Sink" project
    3. Navigate to Settings > Environment variables
    4. Add or update variables as needed
  1. Deployment Process:
  • Automatic deployments are triggered by pushes to the master branch
  • Each deployment creates a unique preview URL
  • Production deployments are served from the main domain (10ksb.link)

Technology Stack

  • Frontend: Vue.js with Nuxt.js
  • Styling: Tailwind CSS
  • Deployment: Cloudflare Pages
  • Language: TypeScript

Troubleshooting

Common Issues

  1. Missing environment variables:
  • Check if all required variables in .env.example are set in your .env file
  • For production, verify variables in Cloudflare Pages dashboard
  1. Deployment issues:
  • Check Cloudflare Pages build logs
  • Verify that all required environment variables are set in Cloudflare
  • Ensure the build command and settings are correct in Cloudflare Pages configuration

Contributing

  1. Create a new branch for your feature
  2. Make your changes
  3. Submit a pull request to the master branch

License

[Add your license information here]

About

⚡ A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 77.2%
  • TypeScript 20.8%
  • JavaScript 1.2%
  • CSS 0.8%