Skip to content

aminetiouk/BetterPhotos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌟 BetterPhoto Project 🌟

HTML5 Sass Vite License: MIT

A sleek and modern web project showcasing a responsive design with a beautiful image gallery and user avatars. Built with a focus on clean code and efficient development workflows.


📖 Table of Contents


✨ Features

  • 🖼️ Stunning Image Gallery: A visually appealing section to display images.
  • 👤 User Avatars: Dedicated section for user profiles or testimonials with avatars.
  • 📱 Fully Responsive Design: Adapts seamlessly to various screen sizes (desktop, tablet, mobile).
  • 🎨 Modern Styling with SCSS: Utilizes SCSS for organized and maintainable stylesheets.
  • Fast Development with Vite: Leverages Vite for a lightning-fast development experience and optimized builds.
  • 🧼 Clean and Semantic HTML5: Well-structured and accessible HTML markup.

🚀 Demo

You can view a live demo of the project here.

🖼️ Screenshot

BetterPhoto screenshot


🛠️ Technologies Used

  • HTML5: For the fundamental structure of the web pages.
  • SCSS (Sass): A powerful CSS preprocessor for writing more maintainable and scalable styles.
  • Vite: A next-generation frontend tooling that provides an extremely fast development environment and bundles your code for production.
  • Node.js: (Implicitly used by Vite and Sass for development tooling).

⚙️ Installation

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have Node.js installed on your machine. You can download it from nodejs.org.

Steps

  1. Clone the repository:

    git clone https://github.com/aminetiouk/BetterPhotos
    cd BetterPhotos
  2. Install NPM packages:

    npm install

▶️ Usage

Once the installation is complete, you can run the project in development mode or build it for production.

Development Mode

To start the development server with hot-reloading:

npm run dev

This will typically open the project in your browser at http://localhost:5173 (or another port if 5173 is in use).

Production Build

To build the project for production, which will generate optimized static assets in a dist folder:

npm run build

📂 Project Structure

.
├── README.md
├── assets/
│   ├── avatar/        # Contains avatar images for users/profiles
│   ├── gallery/       # Contains images for the main gallery
│   └── logo.svg       # Project logo
├── index.html         # The main HTML entry point
├── main.scss          # The main SCSS file for styling
├── package-lock.json  # Records the exact versions of dependencies
├── package.json       # Project metadata and scripts
└── style.css          # Compiled CSS output (generated by Sass/Vite)

🤝 Contributing

  • Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have a suggestion that would make this better, please fork the repo and create a pull request. Don't forget to give the project a star! ⭐


  1. Fork the Project

  2. Create your Feature Branch

    git checkout -b feature/AmazingFeature
  3. Commit your Changes

    git commit -m 'Add some AmazingFeature'
  4. Push to the Branch

    git push origin feature/AmazingFeature
  5. Open a Pull Request


📄 License

Distributed under the MIT License. See LICENSE for more information.

📧 Contact

About

A sleek and modern web project showcasing a responsive design with a beautiful image gallery and user avatars. Built with a focus on clean code and efficient development workflows.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors