This project is deployed at 10ksb.link using Cloudflare Pages.
- Clone the repository:
git clone https://github.com/maconprograms/Sink.git
cd Sink
- 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
- 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
- Environment variables for production are managed through the Cloudflare Pages dashboard
- To add/modify production variables:
- Go to Cloudflare Pages dashboard
- Select the "Sink" project
- Navigate to Settings > Environment variables
- Add or update variables as needed
The project is deployed on Cloudflare Pages with the following setup:
- Domain Configuration:
- Primary domain: 10ksb.link
- Cloudflare Pages URL: sink-e99.pages.dev
- 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)
- Pull latest changes:
git pull origin master
-
Make your changes locally
-
Commit and push changes:
git add .
git commit -m "Your descriptive commit message"
git push origin master
- Cloudflare will automatically deploy your changes
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
- Clone the repository:
git clone https://github.com/maconprograms/Sink.git
cd Sink
- Install dependencies:
pnpm install
- 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
- Start the development server:
pnpm dev
-
Make your changes locally
-
Before committing, ensure:
- Code follows the project's ESLint rules
- All tests pass (if applicable)
- Changes are properly documented
- Commit and push changes:
git add .
git commit -m "Your descriptive commit message"
git push origin master
The project is deployed on Cloudflare Pages with the following setup:
- Domain Configuration:
- Primary domain: 10ksb.link
- Cloudflare Pages URL: sink-e99.pages.dev
- Environment Variables:
- Managed through Cloudflare Pages dashboard
- To add/modify production variables:
- Go to Cloudflare Pages dashboard
- Select the "Sink" project
- Navigate to Settings > Environment variables
- Add or update variables as needed
- 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)
- Frontend: Vue.js with Nuxt.js
- Styling: Tailwind CSS
- Deployment: Cloudflare Pages
- Language: TypeScript
- 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
- 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
- Create a new branch for your feature
- Make your changes
- Submit a pull request to the master branch
[Add your license information here]