Skip to content

README.md

Latest commit

 

History

History
85 lines (55 loc) · 2.83 KB

README.md

File metadata and controls

85 lines (55 loc) · 2.83 KB
Raw

Selfcrafted Web Application

Deploy site

Selfcrafted Logo

Overview

Selfcrafted is a web application designed to provide users with an engaging and interactive experience. The platform allows users to explore crafts, learn about the company, start crafting processes, manage their user profiles, and view their shopping carts.

Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm (v8 or higher)

Installation

  1. Clone the repository:

    git clone https://github.com/TheAnimatrix/SCWeb.git
cd SCWeb

  2. Install dependencies:

    npm install

  3. Set up environment variables:

    • Create a .env file in the root directory.

    • Add your Supabase URL and public API key:

      VITE_SUPABASE_URL=your-supabase-url
VITE_SUPABASE_ANON_KEY=your-supabase-anon-key

  4. Start the development server:

    npm run dev

  5. Open your browser and navigate to http://localhost:5173 to view the application.

Journal content

The blog lives at /blog, with individual stories at /blog/[slug]. Edit the starter articles or add new entries in src/lib/blog/posts.ts. Each entry contains a stable slug, title, excerpt, category, publication date, a cover illustration with alt text and dimensions, and structured body blocks (paragraphs, headings, quotes, or lists). Paragraphs may include links to public sources. Reading times are calculated from the content; the feed and sitemap include the articles automatically. Publish content changes through the normal site deployment.

Blog illustrations are stored in static/images/blog; the generation prompts are recorded in docs/blog-image-prompts.md.

Contributing

Contributions are welcome! Please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with descriptive messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the main repository.

License

This project uses a dual-license model:

  • Default: GNU Affero General Public License v3.0 (AGPL-3.0) — free to use, with copyleft obligations including the network/SaaS clause for modified hosted deployments.
  • Commercial: Required for closed-source/non-copyleft use or commercial use expecting gross revenue over USD $10,000.

See LICENSING.md for the full explanation. Contributors accept CLA.md so contributions may be distributed under both licenses.

Commercial licensing: creo@selfcrafted.in