${content}
${joke.value}
\n Get Another Joke\n `)\n } catch (error) {\n res.send(\"Sorry, couldn't fetch a joke right now.\")\n }\n})\n\n// Weather information (example with caching)\nserver.get('/weather/:city', async (req, res) => {\n const city = req.params.city\n \n // Check if we have cached weather data\n let weather = server.cache(`weather_${city}`)\n \n if (!weather) {\n // Fetch fresh data from API\n try {\n const response = await server.http.get(`https://api.openweathermap.org/data/2.5/weather?q=${city}&appid=YOUR_API_KEY`)\n weather = response.data\n \n // Cache for 10 minutes (600 seconds)\n server.cache(`weather_${city}`, weather, 600)\n } catch (error) {\n return res.send(`Could not fetch weather for ${city}`)\n }\n }\n \n res.send(`\nTemperature: ${weather.main.temp}ยฐF
\nDescription: ${weather.weather[0].description}
\n `)\n})\n\nserver.start(8080)\n```\n\n## ๐๏ธ Database Operations Made Simple\n\nThe built-in database works like a simple JSON database - perfect for prototypes and small applications:\n\n```js\nconst server = require('@fwd/server')\n\n// Create a new record\nconst user = await server.database.create('users', {\n name: 'John Doe',\n email: 'john@example.com',\n age: 30\n})\n\n// Find all users\nconst allUsers = await server.database.get('users')\n\n// Find users with specific criteria\nconst youngUsers = await server.database.find('users', { age: { $lt: 25 } })\n\n// Find one specific user\nconst john = await server.database.findOne('users', { name: 'John Doe' })\n\n// Update a user\nawait server.database.update('users', john.id, { age: 31 })\n\n// Delete a user\nawait server.database.remove('users', john.id)\n```\n\n## ๐ File Operations\n\nHandle files easily with built-in methods:\n\n```js\nconst server = require('@fwd/server')\n\n// Read a file\nconst content = await server.read('./data.txt')\nconsole.log(content)\n\n// Write to a file\nawait server.write('./output.txt', 'Hello, World!')\n\n// Append to a file\nawait server.append('./log.txt', 'New log entry\\n')\n\n// Prepend to a file (add content at the beginning)\nawait server.prepend('./notes.txt', 'Important: ')\n\n// Copy a file\nawait server.copy('./source.txt', './backup.txt')\n\n// Delete a file\nawait server.unlink('./old-file.txt')\n\n// List files in a directory\nconst files = await server.list('./documents')\nconsole.log(files) // ['file1.txt', 'file2.txt', 'folder1']\n```\n\n## โฐ Time and Date Magic\n\nWork with dates using natural language:\n\n```js\nconst server = require('@fwd/server')\n\n// Natural language date parsing\nconsole.log(server.date('next friday')) // Next Friday's date\nconsole.log(server.date('tomorrow')) // Tomorrow's date\nconsole.log(server.date('in 3 days')) // Date 3 days from now\nconsole.log(server.date('last monday')) // Last Monday's date\n\n// Timestamps\nconsole.log(server.timestamp()) // Current Unix timestamp\nconsole.log(server.timestamp('LLLL')) // \"Monday, September 28, 2020 4:30 PM\"\nconsole.log(server.timestamp('LL')) // \"September 28, 2020\"\nconsole.log(server.timestamp('LLL', 'America/New_York')) // With timezone\n\n// Time conversions\nconsole.log(server.time(5, 'seconds')) // 5000 (milliseconds)\nconsole.log(server.time(1, 'hour')) // 3600000 (milliseconds)\nconsole.log(server.time(2, 'days')) // 172800000 (milliseconds)\n```\n\n## โฒ๏ธ Scheduled Tasks (Cron Jobs)\n\nSchedule tasks using natural language:\n\n```js\nconst server = require('@fwd/server')\n\n// Run every hour\nserver.cron(() => {\n console.log('Hourly backup completed')\n}, 'every 1 hour')\n\n// Run every 30 minutes\nserver.cron(() => {\n console.log('Checking for updates...')\n}, 'every 30 minutes')\n\n// Run daily at midnight\nserver.cron(() => {\n console.log('Daily cleanup started')\n}, 'every 1 day')\n\n// Run immediately and then every 5 minutes\nserver.cron(() => {\n console.log('Health check performed')\n}, 'every 5 minutes', true) // true = run immediately\n```\n\n## ๐ Generate Unique IDs\n\nCreate unique identifiers for your data:\n\n```js\nconst server = require('@fwd/server')\n\n// Generate a full UUID\nconst id = server.uuid()\nconsole.log(id) // \"9e471b08-38fe-11eb-adc1-0242ac120002\"\n\n// Generate a shorter UUID\nconst shortId = server.uuid(8)\nconsole.log(shortId) // \"9e471b08\"\n\n// Generate UUID with prefix\nconst prefixedId = server.uuid(16, 'user_')\nconsole.log(prefixedId) // \"user_9e471b08-38fe\"\n\n// Generate UUID without dashes\nconst cleanId = server.uuid(32, '', true)\nconsole.log(cleanId) // \"9e471b0838fe11ebadc10242ac120002\"\n```\n\n## ๐ฅ๏ธ Execute System Commands\n\nRun shell commands from your Node.js application:\n\n```js\nconst server = require('@fwd/server')\n\n// Get system information\nconst cpuUsage = await server.exec('top -l 1 | grep \"CPU usage\"')\nconsole.log(cpuUsage)\n\n// List files in current directory\nconst files = await server.exec('ls -la')\nconsole.log(files)\n\n// Get disk usage\nconst diskUsage = await server.exec('df -h')\nconsole.log(diskUsage)\n\n// Execute with options\nconst result = await server.exec('long-running-command', {\n timeout: 60000, // 60 second timeout\n maxBuffer: 1024 * 1024 // 1MB buffer limit\n})\n```\n\n## ๐พ Caching for Performance\n\nStore data temporarily to improve performance:\n\n```js\nconst server = require('@fwd/server')\n\n// Store data in cache\nserver.cache('user_123', { name: 'John', email: 'john@example.com' })\n\n// Retrieve from cache\nconst user = server.cache('user_123')\nconsole.log(user) // { name: 'John', email: 'john@example.com' }\n\n// Store with expiration (expires in 300 seconds = 5 minutes)\nserver.cache('api_data', { data: 'some data' }, 300)\n\n// Cache will automatically expire after 5 minutes\n```\n\n## ๐ Data Validation\n\nValidate user input with built-in validators:\n\n```js\nconst server = require('@fwd/server')\n\n// Email validation\nconsole.log(server.isEmail('user@example.com')) // true\nconsole.log(server.isEmail('invalid-email')) // false\n\n// Phone number validation\nconsole.log(server.isPhone({ value: '555-123-4567' })) // true\nconsole.log(server.isPhone({ value: '123' })) // false\n```\n\n## ๐ Advanced Server Configuration\n\nConfigure your server with security and performance options:\n\n```js\nconst server = require('@fwd/server')\n\nserver.get('/', (req, res) => {\n res.send('Hello, World!')\n})\n\nserver.start(8080, './my-app', {\n // Security settings\n cors: {\n origin: ['https://mywebsite.com', 'https://app.mywebsite.com'],\n credentials: true\n },\n \n // File size limits\n jsonLimit: '50mb',\n \n // Timezone for timestamps\n timezone: 'America/New_York',\n \n // Static file settings\n publicFolder: './public',\n maxAge: '1d', // Cache static files for 1 day\n \n // Upload settings\n uploadFolder: './uploads',\n \n // View engine\n viewEngine: 'ejs',\n viewsFolder: './views'\n})\n```\n\n## ๐งช Testing\n\nThe framework includes comprehensive testing to ensure reliability and security. All tests pass to maintain API compatibility.\n\n### Running Tests\n\n```bash\n# Run all tests\nnpm test\n\n# Run tests in watch mode (reruns when files change)\nnpm run test:watch\n\n# Run tests with coverage report\nnpm run test:coverage\n```\n\n### Test Coverage\n\nThe test suite covers:\n\n- โ **File Operations** - Read, write, append, prepend, delete, copy, list\n- โ **Utility Functions** - Command execution, sleep, UUID generation, time/date functions\n- โ **Validation Functions** - Email and phone number validation\n- โ **Cron Functionality** - Scheduled task execution\n- โ **Caching** - Data storage and retrieval with expiration\n- โ **Server Setup** - HTTP method registration and routing\n- โ **Integration Tests** - End-to-end functionality testing\n\n### Test Structure\n\n```\n__tests__/\nโโโ file-operations.test.js # File system operations\nโโโ utility-functions.test.js # Core utility functions\nโโโ validation-functions.test.js # Input validation\nโโโ cron-functionality.test.js # Scheduled tasks\nโโโ cache-functionality.test.js # Caching system\nโโโ server-setup.test.js # Server configuration\nโโโ integration.test.js # End-to-end tests\n```\n\n## ๐ Security Features\n\nThe framework includes comprehensive security measures to protect your applications:\n\n### ๐ก๏ธ Built-in Security Protections\n\n#### **Command Injection Prevention**\n- Input validation and sanitization\n- Dangerous character filtering (`;&|`$(){}[]\\`)\n- Command length limits (1000 characters)\n- Execution timeouts (30 seconds default)\n- Buffer size limits (1MB)\n\n#### **Path Traversal Protection**\n- Path normalization and validation\n- Prevention of `..` directory traversal attacks\n- Secure file operation handling\n\n#### **File Operation Security**\n- File size limits (50MB for files, 1MB for append/prepend)\n- Input type validation\n- Proper error handling without information disclosure\n\n#### **Web Security Headers**\n- `X-Frame-Options: DENY` - Prevents clickjacking attacks\n- `X-Content-Type-Options: nosniff` - Prevents MIME sniffing attacks\n- `X-XSS-Protection: 1; mode=block` - Enables XSS protection\n- `Strict-Transport-Security` - Enforces HTTPS connections\n- `Content-Security-Policy` - Restricts script and style sources\n\n#### **CORS Security**\n- Disabled by default (requires explicit configuration)\n- Configurable allowed origins\n- Credentials disabled by default\n\n#### **Input Validation**\n- Enhanced email validation with length limits (254 characters)\n- Improved phone validation with proper error handling\n- UUID generation with parameter validation\n- Cron job validation with interval limits (1 second minimum)\n\n#### **Resource Protection**\n- JSON payload size limits (1GB default, configurable)\n- URL-encoded data limits\n- Cron interval limits to prevent resource exhaustion\n\n### ๐ Security Best Practices Implemented\n\n1. **Defense in Depth** - Multiple layers of security controls\n2. **Fail Secure** - Default to secure configurations\n3. **Input Validation** - Comprehensive validation at all entry points\n4. **Error Handling** - Graceful error handling without information disclosure\n5. **Resource Limits** - Protection against resource exhaustion attacks\n\n### ๐จ Security Recommendations\n\nWhen using this framework in production:\n\n1. **Configure CORS properly** - Only allow trusted origins\n2. **Set appropriate file size limits** - Based on your application needs\n3. **Use HTTPS** - Enable SSL/TLS for secure communications\n4. **Validate all inputs** - Use the built-in validators and add custom validation\n5. **Monitor logs** - Keep an eye on error logs for suspicious activity\n6. **Regular updates** - Keep dependencies updated for security patches\n\n## ๐ค Contributing\n\nWe welcome contributions! Here's how you can help:\n\n1. **Report Issues** - Found a bug? Let us know!\n2. **Suggest Features** - Have an idea? We'd love to hear it!\n3. **Submit Pull Requests** - Fix bugs or add features\n4. **Improve Documentation** - Help others learn\n\n### Development Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/fwd/server.git\n\n# Install dependencies\nnpm install\n\n# Run tests\nnpm test\n\n# Run tests in watch mode\nnpm run test:watch\n```\n\n## ๐ License\n\nMIT License - feel free to use this in your projects!\n\nCopyright ยฉ [@nano2dev](https://twitter.com/nano2dev).\n\n## โญ Show Your Support\n\nGive a โญ๏ธ if this project helped you! It motivates us to keep improving.\n\n## ๐ Project Stats\n\n[](https://starchart.cc/fwd/server)\n\n---\n\n**Ready to build something amazing?** Start with the Quick Start example above and let your creativity flow! ๐","readmeFilename":"README.md"}