README.md

AppExpress

AppExpress is a lightweight framework, inspired by express.js and meticulously designed for Appwrite Functions. It simplifies creating server-like functionalities through an intuitive API that simplifies routing, middleware integration, and more.

Note

This package is compatible with Appwrite server version 1.6.x.

Documentation

For installation instructions and additional resources, please visit the Wiki Page.

Integrations

Checkout the appexpress-essentials repository for middlewares, view-engines and more.

Live Action Demo

Discover AppExpress in action through a demo:

• AppExpress
• All AppExpress Routes

How to Contribute

Your contributions are valued, whether it's reporting issues or suggesting enhancements!

• Reporting Issues

  Encounter a bug or have a suggestion? Please file it via the issue tracker.

• Submitting Pull Requests

  Want to make contributions? Here’s how you can do so effectively:

  1. Fork the Repository & Create a Branch

     • Fork the repo and start from a new branch.
     • Name your branch appropriately:
       • Bug fixes: fix-issueNumber-description (e.g., fix-11-remove-excess-forward-slashes)
       • Feature additions: feat-issueNumber-description (e.g., feat-09-add-view-engine-support)
       • Documentation tweaks: Clearly state the nature of your updates.

  2. Develop & Test

     • Implement your changes and ensure code quality by running npm run lint.
     • Resolve any formatting issues with npm run format.
     • For new features or refactoring, add and run tests using npm run tests.

  3. Open a Pull Request

     • Ensure you're assigned to the issue before proceeding to PR.

Support the Project

Give the project a ⭐️ to show your support!