@fecommunity/reactpress-server 1.0.0-beta.3 → 1.0.0-beta.31

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FECommunity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,395 +1,134 @@
 # @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@1.0.0-beta.1 @fecommunity/reactpress-config@1.0.0-beta.1
-
-# Using yarn
-yarn add @fecommunity/reactpress-server@1.0.0-beta.1 @fecommunity/reactpress-config@1.0.0-beta.1
-
-# Using pnpm in workspace root (add -w flag)
-pnpm add -w @fecommunity/reactpress-server@1.0.0-beta.1 @fecommunity/reactpress-config@1.0.0-beta.1
-
-# Using pnpm in standalone project
-pnpm add @fecommunity/reactpress-server@1.0.0-beta.1 @fecommunity/reactpress-config@1.0.0-beta.1
-```
-
-## 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
+ReactPress Server - NestJS-based backend API for ReactPress CMS with WordPress-style 5-minute installation.
 
 ## Quick Start
 
-### 1. Initialize Server
+### Installation & Setup
 
 ```bash
-# Using npx (recommended for first-time use)
-npx @fecommunity/reactpress-server init
+# Regular startup
+npx @fecommunity/reactpress-server
 
-# Or if installed globally
-reactpress-server init
+# PM2 startup
+npx @fecommunity/reactpress-server --pm2
 ```
 
-This will create configuration files and set up your environment.
+That's it! The command will automatically:
 
-### 2. Start Development Server
+1. **Auto-detect** if configuration exists
+2. **Launch installation wizard** in your browser if no configuration found
+3. **Start the server** immediately after installation
+4. **Open API documentation** at `http://localhost:3002/api`
 
-```bash
-# Using npx
-npx @fecommunity/reactpress-server dev
+### Features
 
-# Or if installed globally
-reactpress-server dev
-```
+- 🚀 **Zero-command installation** - No complex CLI parameters needed
+- 🌍 **WordPress-style setup** - Familiar 5-minute installation process
+- 🔧 **Auto-configuration** - Generates `.env` files automatically
+- 🔌 **Database auto-setup** - Creates MySQL database if it doesn't exist
+- 🎯 **Seamless flow** - From installation to running server in minutes
+- 📖 **Auto-documentation** - Swagger API docs available immediately
+- ⚡ **PM2 support** - Optional PM2 process management for production
 
-The server will start on `http://localhost:3002` with API documentation at `http://localhost:3002/api`.
+### Requirements
 
-### 3. Start Production Server
+- Node.js >= 16.5.0
+- MySQL 5.7+ or 8.0+
 
-```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:
+### Usage Scenarios
 
-### 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)
-```
+#### Standalone API Server
+Perfect for:
+- Headless CMS implementation
+- Mobile app backend
+- Microservices architecture
+- Custom frontend integration
 
-### Development Mode
+#### Full ReactPress Stack
+Use with ReactPress client for complete CMS solution:
 ```bash
-# Using npx
-npx @fecommunity/reactpress-server dev [options]
-
-# Or if installed globally
-reactpress-server dev [options]
+# Start server
+npx @fecommunity/reactpress-server
 
-Options:
-  -p, --port <port>     Server port (default: 3002)
-  --no-open            Don't open browser automatically
+# In another terminal, start client
+npx @fecommunity/reactpress-client
 ```
 
-### Production Mode
-```bash
-# Using npx
-npx @fecommunity/reactpress-server start [options]
-
-# Or if installed globally
-reactpress-server start [options]
+### PM2 Support
 
-Options:
-  -p, --port <port>     Server port (default: 3002)
-```
+ReactPress server supports PM2 process management for production deployments:
 
-### Build Project
 ```bash
-# Using npx
-npx @fecommunity/reactpress-server build
-
-# Or if installed globally
-reactpress-server build
+# Start with PM2
+npx @fecommunity/reactpress-server --pm2
 ```
 
-## Environment Configuration
+PM2 features:
+- Automatic process restart on crash
+- Memory monitoring
+- Log management
+- Cluster mode support
 
-Create a `.env` file in your project root:
+### Configuration
 
-```env
-# Server Configuration
-SERVER_PORT=3002
-SERVER_API_PREFIX=/api
-NODE_ENV=development
+The installation wizard will create a `.env` file with:
 
-# Database Configuration
-DB_HOST=localhost
+```env
+DB_HOST=127.0.0.1
 DB_PORT=3306
-DB_USERNAME=root
-DB_PASSWORD=your_password
+DB_USER=your_username
+DB_PASSWD=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
+CLIENT_SITE_URL=http://localhost:3001
+SERVER_SITE_URL=http://localhost:3002
 ```
 
-**macOS:**
-```bash
-brew install mysql
-brew services start mysql
-```
+### API Documentation
 
-**Windows:**
-Download and install from [MySQL Official Website](https://dev.mysql.com/downloads/mysql/)
+Once running, visit `http://localhost:3002/api` for:
+- Interactive Swagger documentation
+- API endpoint explorer
+- Authentication examples
+- Response schemas
 
-### 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)
+### Development
 
 ```bash
-# Install PM2
-npm install -g pm2
+# Clone repository
+git clone https://github.com/fecommunity/reactpress.git
+cd reactpress/server
 
-# Start with PM2
-npm run pm2
-
-# Monitor
-pm2 monitor
-```
+# Install dependencies
+npm install
 
-### Docker
-
-```dockerfile
-FROM node:18-alpine
-WORKDIR /app
-COPY package*.json ./
-RUN npm install
-COPY . .
-RUN npm run build
-EXPOSE 3002
-CMD ["npm", "start"]
-```
+# Start development server
+npm run dev
 
-### 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"
+# Start with PM2 (development)
+npm run pm2:start
 ```
 
-## Integration with Frontend
-
-Use with ReactPress client:
+### Docker Support
 
 ```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`
+# Using Docker
+docker run -p 3002:3002 @fecommunity/reactpress-server
 
-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
+# Using docker-compose
+docker-compose up reactpress-server
 ```
 
-## Contributing
+### Support
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+- 📖 [Documentation](https://github.com/fecommunity/reactpress)
+- 🐛 [Issues](https://github.com/fecommunity/reactpress/issues)
+- 💬 [Discussions](https://github.com/fecommunity/reactpress/discussions)
 
-## License
+### License
 
-MIT
+MIT License - see [LICENSE](LICENSE) file for details.
 
-## 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)
+Built with ❤️ by [FECommunity](https://github.com/fecommunity)