Skip to content

README.md

Latest commit

 

History

History
106 lines (73 loc) · 2.44 KB

README.md

File metadata and controls

106 lines (73 loc) · 2.44 KB

🍭 Fullstack Candy Shop with SolidStart 🍬

Welcome to the Fullstack Candy Shop project! This project is built using SolidStart, a JavaScript framework designed to build SolidJS apps and deploy them to a variety of providers.

🌟 Features

  • 🛒 Shopping Cart: Add and manage your candy items.
  • 🌈 Dark Mode: Toggle between light and dark themes.
  • ⚛️ SolidJS Components: Efficient and reactive components.
  • 🚀 Server-Side Rendering: Fast initial load times.
  • 🎨 Tailwind CSS: Beautiful, responsive design.

📂 Project Structure

Here's a quick overview of the project's structure:

src/
├── context/
├── lib/
├── routes/
│   ├── api/
│   ├── product/
│   │   ├── [productId].tsx
│   │   ├── about.tsx
│   │   ├── cart.tsx
│   │   ├── index.tsx
├── styles/
│   ├── _variables.scss
│   ├── global.css
│   ├── index.scss
├── types/
├── app.css
├── app.tsx
├── entry-client.tsx
├── entry-server.tsx
global.d.ts
.editorconfig
.env

🚀 Getting Started

Follow these steps to get the project up and running on your local machine:

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/andrenormanlang/fullstack-candy-shop-solid-start.git
cd fullstack-candy-shop-solid-start

  2. Install dependencies:

    npm install

  3. Run the development server:

    npm run dev

  4. Open your browser and navigate to http://localhost:3000

🎨 Styling

This project uses SCSS for styling. Make sure to compile your SCSS files to CSS using the following command:

npm run build:css

🛠️ Commands

  • Start Development Server: npm run dev
  • Build for Production: npm run build
  • Compile SCSS: npm run build:css

🤝 Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue.

📜 License

This project is licensed under the MIT License.

✨ Acknowledgements

  • Thanks to the SolidJS and SolidStart teams for their amazing work!
  • Icons by solid-icons

📬 Contact

Feel free to reach out if you have any questions or suggestions!

Happy Coding! 🎉