Afterwork.js

Afterwork.js: Backend framework that isn't loved properly by even his mother. 🚬🥃

Overview

Welcome to Afterwork.js – a backend framework that's as lightweight, fast, and atomic as they come. Designed with simplicity in mind, Afterwork.js provides the essentials you need to build efficient and effective server-side applications without the bloat.

Features

• Lightweight: Minimal overhead ensures your applications run fast and efficiently.
• Fast: Optimized for speed, Afterwork.js delivers high performance with minimal resources.
• Atomic: Focuses on core functionalities to keep things simple and manageable.

Getting Started

To get started with Afterwork.js, follow these simple steps:

1. Install Afterwork.js

   npm install kuaralabs-afterworkjs

2. Create Your Server

   Create a file named server.js:

   import { AfterworkJS } from 'afterworkjs';
   
   // you can use dotenv
   const SECRET_KEY = 'your_secret_key';  // Replace with your actual secret key
   const DB_URL = 'your_database_url';    // Replace with your actual database URL
   const DB_NAME = 'your_database_name';  // Replace with your actual database name
      
   const app = new AfterworkJS({
     secret: SECRET_KEY,
     dbType: "postgres",                  // Replace with the databases that is supported
     dbConfig: {
       dbUrl: DB_URL,
       dbName: DB_NAME
     }
   });
   
   app.addRoute('get', '/hello', (req, res, next) => {
     res.json({ message: 'Hello, world!' });
   });
   
   app.start(3000);

3. Run Your Server

   npm start

   Your server will be running on port 3000.

Features

• Simple Routing: Define routes with ease using addRoute.
• Middleware Support: Easily add middleware for request processing.
• Database Integration: Supports MongoDB, PostgreSQL, and MySQL out of the box.
• JWT Authentication: Secure your routes with JSON Web Tokens.

Example Usages

Here's a simple example of how to use Afterwork.js for routing and middleware:

import { AfterworkJS } from 'afterworkjs';

// you can use dotenv
const SECRET_KEY = 'your_secret_key';  // Replace with your actual secret key
const DB_URL = 'your_database_url';    // Replace with your actual database URL
const DB_NAME = 'your_database_name';  // Replace with your actual database name

const app = new AfterworkJS({
  secret: SECRET_KEY,
  dbType: "postgres",                  // Replace with the databases that is supported
  dbConfig: {
    dbUrl: DB_URL,
    dbName: DB_NAME
  }
});

// Middleware to log requests
app.use((req, res, next) => {
  console.log(`${req.method} ${req.url}`);
  next();
});

// Route to handle GET requests
app.addRoute('get', '/users', async (req, res) => {
  const users = await req.db.find('users', {});
  res.json(users);
});

// Start the server
app.start(3000);

and you can try wildcard

import { AfterworkJS } from 'afterworkjs';

// you can use dotenv
const SECRET_KEY = 'your_secret_key';  // Replace with your actual secret key
const DB_URL = 'your_database_url';    // Replace with your actual database URL
const DB_NAME = 'your_database_name';  // Replace with your actual database name

const app = new AfterworkJS({ 
  secret: SECRET_KEY, 
  dbType: 'mongo', 
  dbConfig: {
    dbUrl: DB_URL,
    dbName: DB_NAME
  } 
  });

app.addRoute('get', '/api/users/:id', (req, res) => {
  res.json({ userId: req.params.id });
});

app.addRoute('get', '/api/*', (req, res) => {
  res.json({ message: 'Wildcard route' });
});

app.start(3000);

Documentation

For detailed documentation on Afterwork.js, visit the official documentation.

Contributing

Contributions are welcome! Please submit issues, feature requests, and pull requests to the GitHub repository.

License

Afterwork.js is licensed under the MIT License.

Disclaimer

Afterwork.js: It might not be loved by everyone, but it gets the job done 🚬

feel free to contact us with [email protected] or with please "afterworkjs" title at [email protected]