mirror of
https://github.com/shadoll/sLogos.git
synced 2025-12-20 03:26:59 +00:00
refactor: Update documentation for clarity and accuracy
This commit is contained in:
@@ -1,21 +1,6 @@
|
||||
# Logo Gallery - Developer Documentation
|
||||
|
||||
This document provides instructions for developers working on the Logo Gallery project.
|
||||
|
||||
## Project Overview
|
||||
|
||||
Logo Gallery is a web application that displays a collection of company and brand logos with the following features:
|
||||
- Grid and list views of logos
|
||||
- Search functionality
|
||||
- Direct URL copying for each logo
|
||||
- Download capability
|
||||
- Responsive design
|
||||
|
||||
The project is built with:
|
||||
- Svelte for the front-end UI
|
||||
- Node.js for script automation
|
||||
- Docker for containerization
|
||||
- GitHub Pages for deployment
|
||||
This document provides instructions for setting up, running, and contributing to the Logo Gallery project.
|
||||
|
||||
## Development Environment Setup
|
||||
|
||||
@@ -70,7 +55,7 @@ make run CMD="your-command-here"
|
||||
```
|
||||
|
||||
Examples:
|
||||
- List logo files: `make run CMD="ls -la public/assets/logos"`
|
||||
- List logo files: `make run CMD="ls -la public/logos"`
|
||||
- Run a specific npm script: `make run CMD="npm run some-script"`
|
||||
|
||||
## Project Structure
|
||||
@@ -78,8 +63,7 @@ Examples:
|
||||
```
|
||||
logos/
|
||||
├── public/ # Static assets
|
||||
│ ├── assets/
|
||||
│ │ └── logos/ # Logo files (SVG, PNG)
|
||||
│ ├── logos/ # Logo files (SVG, PNG)
|
||||
│ ├── data/ # JSON data files
|
||||
│ ├── build/ # Compiled JS/CSS (generated)
|
||||
│ └── global.css # Global styles
|
||||
@@ -117,7 +101,7 @@ Run `make help` to see all available commands:
|
||||
- `make restart` - Restart the application
|
||||
- `make logs` - View the application logs
|
||||
- `make run CMD=<cmd>` - Run a command in the container
|
||||
- `make generate-logos` - Generate logos.json from assets directory
|
||||
- `make scan-logos-dev` - Scan logos directory and update logos.json
|
||||
- `make clean` - Clean up build artifacts
|
||||
- `make rebuild` - Completely rebuild from scratch
|
||||
|
||||
|
||||
83
README.md
83
README.md
@@ -2,94 +2,13 @@
|
||||
|
||||
A collection of company and brand logos hosted on GitHub Pages. This project provides an easy way to access and use various brand logos in SVG and PNG formats with a user-friendly interface.
|
||||
|
||||
## Features
|
||||
|
||||
- Browse logos in grid or list view
|
||||
- Search functionality to find specific logos
|
||||
- Copy direct URL to any logo with one click
|
||||
- Download logos directly
|
||||
- Responsive design that works on mobile and desktop
|
||||
|
||||
## Project Setup
|
||||
|
||||
### Running with Docker (Recommended)
|
||||
|
||||
The easiest way to run the project locally is using Docker, which doesn't require installing Node.js or npm packages directly on your system:
|
||||
|
||||
1. Clone this repository:
|
||||
```
|
||||
git clone https://github.com/yourusername/logos.git
|
||||
cd logos
|
||||
```
|
||||
|
||||
2. Start the Docker container:
|
||||
```
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
The application will be available at http://localhost:5000 with live reloading enabled.
|
||||
|
||||
### Running Manually (Alternative)
|
||||
|
||||
If you prefer to run the project without Docker:
|
||||
|
||||
1. Clone this repository:
|
||||
```
|
||||
git clone https://github.com/yourusername/logos.git
|
||||
cd logos
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
3. Start the development server:
|
||||
```
|
||||
npm run dev
|
||||
```
|
||||
|
||||
4. Build for production deployment:
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Deploying to GitHub Pages
|
||||
|
||||
1. Build the project:
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
|
||||
2. Push the contents to your GitHub repository's `gh-pages` branch.
|
||||
|
||||
## Adding New Logos
|
||||
|
||||
To add new logos to the collection:
|
||||
|
||||
1. Add the logo file (SVG or PNG) to the `public/logos/` directory
|
||||
2. Run the logo scan script:
|
||||
```
|
||||
make scan-logos-dev
|
||||
```
|
||||
(This runs `npm run scan-logos` inside the dev container)
|
||||
3. The application will automatically rebuild with the new logos
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
logos/
|
||||
├── public/ # Static assets
|
||||
│ ├── assets/
|
||||
│ │ └── logos/ # Logo files
|
||||
│ └── global.css # Global styles
|
||||
├── src/ # Application source code
|
||||
│ ├── components/ # Svelte components
|
||||
│ ├── data/ # Data files
|
||||
│ ├── App.svelte # Main app component
|
||||
│ └── main.js # App entry point
|
||||
└── index.html # HTML entry point
|
||||
```
|
||||
For setup, development, and deployment instructions, see [DEVELOPMENT.md](./DEVELOPMENT.md).
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user