Updatweb
This commit is contained in:
81
README.md
Normal file
81
README.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# Sky Art Shop
|
||||
|
||||
Your destination for creative stationery and art supplies.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
SkyArtShop/
|
||||
├── backend/ # Node.js/Express server code
|
||||
├── website/ # Frontend HTML/CSS/JS files
|
||||
│ ├── admin/ # Admin panel pages
|
||||
│ ├── public/ # Public-facing pages
|
||||
│ └── assets/ # CSS, JS, images
|
||||
├── docs/ # Documentation and guides
|
||||
├── scripts/ # Shell scripts and automation
|
||||
├── config/ # Configuration files (nginx, pm2, etc.)
|
||||
├── old-backups/ # Archived backups
|
||||
└── old-docs/ # Archived documentation
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Install Dependencies:**
|
||||
```bash
|
||||
cd backend && npm install
|
||||
```
|
||||
|
||||
1. **Configure Environment:**
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
# Edit .env with your database credentials
|
||||
```
|
||||
|
||||
2. **Start Development Server:**
|
||||
|
||||
```bash
|
||||
./scripts/dev-start.sh
|
||||
```
|
||||
|
||||
3. **Access the Site:**
|
||||
- Public Site: <http://localhost:5000>
|
||||
- Admin Panel: <http://localhost:5000/admin/login.html>
|
||||
|
||||
## Key Documentation
|
||||
|
||||
Located in `docs/` folder:
|
||||
|
||||
- **QUICK_START.md** - Get started quickly
|
||||
- **WORKFLOW.md** - Development workflow guide
|
||||
- **SERVER_MANAGEMENT.md** - Server deployment and management
|
||||
- **DEVELOPMENT_MODE.md** - Running in development mode
|
||||
- **GIT-README.md** - Git workflow and commands
|
||||
|
||||
## Useful Scripts
|
||||
|
||||
Located in `scripts/` folder:
|
||||
|
||||
- `dev-start.sh` - Start development server
|
||||
- `deploy-website.sh` - Deploy to production
|
||||
- `quick-status.sh` - Check server status
|
||||
- `manage-server.sh` - Server management utilities
|
||||
|
||||
## Configuration Files
|
||||
|
||||
Located in `config/` folder:
|
||||
|
||||
- `ecosystem.config.js` - PM2 process configuration
|
||||
- `nginx-*.conf` - Nginx configuration files
|
||||
- `skyartshop.service` - systemd service file
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Backend:** Node.js, Express
|
||||
- **Database:** PostgreSQL
|
||||
- **Frontend:** HTML5, CSS3, Vanilla JavaScript
|
||||
- **Process Manager:** PM2
|
||||
- **Web Server:** Nginx
|
||||
|
||||
## Support
|
||||
|
||||
For questions or issues, check the documentation in the `docs/` folder or contact <support@skyartshop.com>.
|
||||
Reference in New Issue
Block a user