@fecommunity/reactpress-server 1.0.3-beta.0 → 1.0.4-beta.0

package/README.md

@@ -0,0 +1,395 @@
+# @fecommunity/reactpress-server
+
+NestJS-based backend API server for ReactPress - A modern React-based CMS platform.
+
+## Installation
+
+```bash
+# For new projects
+npm install @fecommunity/reactpress-server @fecommunity/reactpress-config
+
+# Using yarn
+yarn add @fecommunity/reactpress-server @fecommunity/reactpress-config
+
+# Using pnpm in workspace root (add -w flag)
+pnpm add -w @fecommunity/reactpress-server @fecommunity/reactpress-config
+
+# Using pnpm in standalone project
+pnpm add @fecommunity/reactpress-server @fecommunity/reactpress-config
+```
+
+## Features
+
+- 🚀 **NestJS Framework** - Built on modern, scalable Node.js framework
+- 🔐 **Authentication & Authorization** - JWT-based auth with role management
+- 📝 **Content Management** - Full CRUD for articles, categories, tags, and comments
+- 🗃️ **Database Integration** - MySQL support with TypeORM
+- 📁 **File Upload** - Local and cloud storage support (Ali OSS)
+- 🌍 **Internationalization** - Multi-language support
+- 📚 **API Documentation** - Auto-generated Swagger docs
+- 🔒 **Security** - Rate limiting, CORS, Helmet integration
+
+## Quick Start
+
+### 1. Initialize Server
+
+```bash
+# Using npx (recommended for first-time use)
+npx @fecommunity/reactpress-server init
+
+# Or if installed globally
+reactpress-server init
+```
+
+This will create configuration files and set up your environment.
+
+### 2. Start Development Server
+
+```bash
+# Using npx
+npx @fecommunity/reactpress-server dev
+
+# Or if installed globally
+reactpress-server dev
+```
+
+The server will start on `http://localhost:3002` with API documentation at `http://localhost:3002/api`.
+
+### 3. Start Production Server
+
+```bash
+# Using npx
+npx @fecommunity/reactpress-server start
+
+# Or if installed globally
+reactpress-server start
+```
+
+## CLI Commands
+
+The package includes a powerful CLI for server management:
+
+### Initialize Project
+```bash
+# Using npx (recommended)
+npx @fecommunity/reactpress-server init [options]
+
+# Or if installed globally
+reactpress-server init [options]
+
+Options:
+  -p, --port <port>     Server port (default: 3002)
+  --api-prefix <prefix> API prefix (default: /api)
+  --db-host <host>      Database host (default: localhost)
+  --db-port <port>      Database port (default: 3306)
+  --db-name <name>      Database name (default: reactpress)
+```
+
+### Development Mode
+```bash
+# Using npx
+npx @fecommunity/reactpress-server dev [options]
+
+# Or if installed globally
+reactpress-server dev [options]
+
+Options:
+  -p, --port <port>     Server port (default: 3002)
+  --no-open            Don't open browser automatically
+```
+
+### Production Mode
+```bash
+# Using npx
+npx @fecommunity/reactpress-server start [options]
+
+# Or if installed globally
+reactpress-server start [options]
+
+Options:
+  -p, --port <port>     Server port (default: 3002)
+```
+
+### Build Project
+```bash
+# Using npx
+npx @fecommunity/reactpress-server build
+
+# Or if installed globally
+reactpress-server build
+```
+
+## Environment Configuration
+
+Create a `.env` file in your project root:
+
+```env
+# Server Configuration
+SERVER_PORT=3002
+SERVER_API_PREFIX=/api
+NODE_ENV=development
+
+# Database Configuration
+DB_HOST=localhost
+DB_PORT=3306
+DB_USERNAME=root
+DB_PASSWORD=your_password
+DB_DATABASE=reactpress
+
+# JWT Configuration
+JWT_SECRET=your_jwt_secret_key
+JWT_EXPIRES_IN=7d
+
+# File Upload (Optional - Ali OSS)
+OSS_ACCESS_KEY_ID=your_access_key_id
+OSS_ACCESS_KEY_SECRET=your_access_key_secret
+OSS_BUCKET=your_bucket_name
+OSS_REGION=your_region
+
+# Email Configuration (Optional)
+EMAIL_HOST=smtp.gmail.com
+EMAIL_PORT=587
+EMAIL_USER=your_email@gmail.com
+EMAIL_PASS=your_app_password
+```
+
+## Programmatic Usage
+
+You can also use the server programmatically in your Node.js applications:
+
+```typescript
+import { bootstrap } from '@fecommunity/reactpress-server';
+
+async function startServer() {
+  const app = await bootstrap({
+    port: 3002,
+    apiPrefix: '/api',
+    cors: true
+  });
+  
+  console.log('ReactPress server started successfully!');
+}
+
+startServer();
+```
+
+## API Endpoints
+
+The server provides comprehensive REST APIs:
+
+### Authentication
+- `POST /api/auth/login` - User login
+- `POST /api/auth/register` - User registration
+- `GET /api/auth/profile` - Get user profile
+
+### Articles
+- `GET /api/articles` - Get articles (with pagination)
+- `POST /api/articles` - Create article
+- `GET /api/articles/:id` - Get article by ID
+- `PUT /api/articles/:id` - Update article
+- `DELETE /api/articles/:id` - Delete article
+
+### Categories
+- `GET /api/categories` - Get all categories
+- `POST /api/categories` - Create category
+- `PUT /api/categories/:id` - Update category
+- `DELETE /api/categories/:id` - Delete category
+
+### Tags
+- `GET /api/tags` - Get all tags
+- `POST /api/tags` - Create tag
+- `PUT /api/tags/:id` - Update tag
+- `DELETE /api/tags/:id` - Delete tag
+
+### Comments
+- `GET /api/comments` - Get comments
+- `POST /api/comments` - Create comment
+- `PUT /api/comments/:id` - Update comment
+- `DELETE /api/comments/:id` - Delete comment
+
+### File Upload
+- `POST /api/upload/image` - Upload image
+- `POST /api/upload/file` - Upload file
+
+## Database Setup
+
+### MySQL Installation
+
+**Ubuntu/Debian:**
+```bash
+sudo apt update
+sudo apt install mysql-server
+sudo mysql_secure_installation
+```
+
+**macOS:**
+```bash
+brew install mysql
+brew services start mysql
+```
+
+**Windows:**
+Download and install from [MySQL Official Website](https://dev.mysql.com/downloads/mysql/)
+
+### Database Creation
+
+```sql
+CREATE DATABASE reactpress;
+CREATE USER 'reactpress'@'localhost' IDENTIFIED BY 'your_password';
+GRANT ALL PRIVILEGES ON reactpress.* TO 'reactpress'@'localhost';
+FLUSH PRIVILEGES;
+```
+
+## Advanced Usage
+
+### Custom Configuration
+
+```typescript
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from '@fecommunity/reactpress-server';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  
+  // Custom middleware
+  app.use('/custom', customMiddleware);
+  
+  // Custom global filters
+  app.useGlobalFilters(new CustomExceptionFilter());
+  
+  await app.listen(3002);
+}
+
+bootstrap();
+```
+
+### Plugin Development
+
+```typescript
+import { Module } from '@nestjs/common';
+import { PluginInterface } from '@fecommunity/reactpress-server';
+
+@Module({
+  // Your plugin implementation
+})
+export class CustomPlugin implements PluginInterface {
+  install() {
+    // Plugin installation logic
+  }
+}
+```
+
+## Deployment
+
+### PM2 (Recommended)
+
+```bash
+# Install PM2
+npm install -g pm2
+
+# Start with PM2
+npm run pm2
+
+# Monitor
+pm2 monitor
+```
+
+### Docker
+
+```dockerfile
+FROM node:18-alpine
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+COPY . .
+RUN npm run build
+EXPOSE 3002
+CMD ["npm", "start"]
+```
+
+### Docker Compose
+
+```yaml
+version: '3.8'
+services:
+  reactpress-server:
+    build: .
+    ports:
+      - "3002:3002"
+    environment:
+      - DB_HOST=mysql
+      - DB_USERNAME=root
+      - DB_PASSWORD=password
+      - DB_DATABASE=reactpress
+    depends_on:
+      - mysql
+  
+  mysql:
+    image: mysql:5.7
+    environment:
+      - MYSQL_ROOT_PASSWORD=password
+      - MYSQL_DATABASE=reactpress
+    ports:
+      - "3306:3306"
+```
+
+## Integration with Frontend
+
+Use with ReactPress client:
+
+```bash
+# Install both server and client
+npm install @fecommunity/reactpress-server @fecommunity/reactpress-client @fecommunity/reactpress-config
+
+# Start server
+npx reactpress-server dev
+
+# In another terminal, start client
+npx reactpress-client dev
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Database Connection Error**
+   ```
+   Error: connect ECONNREFUSED 127.0.0.1:3306
+   ```
+   - Ensure MySQL is running
+   - Check database credentials in `.env`
+
+2. **Port Already in Use**
+   ```
+   Error: listen EADDRINUSE :::3002
+   ```
+   - Change port in `.env` file or use `-p` option
+
+3. **JWT Secret Missing**
+   ```
+   Error: JWT_SECRET is not defined
+   ```
+   - Add `JWT_SECRET=your_secret_key` to `.env`
+
+### Debug Mode
+
+Start server with debug information:
+
+```bash
+DEBUG=* npx reactpress-server dev
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT
+
+## Links
+
+- [GitHub Repository](https://github.com/fecommunity/reactpress)
+- [Documentation](https://reactpress.surge.sh)
+- [npm Package](https://www.npmjs.com/package/@fecommunity/reactpress-server)
+- [API Documentation](http://localhost:3002/api) (when server is running)

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@fecommunity/reactpress-server",
-  "version": "1.0.3-beta.0",
+  "version": "1.0.4-beta.0",
   "description": "ReactPress Server - NestJS-based backend API for ReactPress CMS",
   "author": "fecommunity",
   "license": "MIT",
   "main": "dist/main.js",
   "types": "dist/index.d.ts",
   "bin": {
-    "@fecommunity/reactpress-server": "../scripts/reactpress-server.js"
+    "@fecommunity/reactpress-server": "./scripts/reactpress-server.js"
   },
   "files": [
     "dist/**/*",
@@ -53,7 +53,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@fecommunity/reactpress-config": "workspace:^1.0.0",
+    "@fecommunity/reactpress-config": "^1.0.6-beta.0",
     "@nestjs/common": "^6.7.2",
     "@nestjs/config": "^0.6.3",
     "@nestjs/core": "^6.7.2",