Achieve v3 Documentation
Build Node.js applications without building the server first.
Achieve is a lightweight web and HTTP application server for Node.js. It automatically serves static resources, maps URLs into your application space, and invokes backend JavaScript request handlers called Servlets. Common request and response processing is already part of the server, so application development can begin with application code instead of framework and middleware assembly.
JavaScript Servlets can use ordinary Node.js modules and npm packages. Development mode reloads changed Servlet code automatically. Configurable HTTP cache handling, compression, logging, routing, HTTPS, and HTTP/2 are available when needed; production mode separately retains loaded application modules until restart. Achieve has zero runtime dependencies and can support anything from a small site to a substantial full-stack JavaScript application.
Start with the short tutorials below, use the references for exact behavior, and consult the technical specifications, tests, and qualified engineering evidence for implementation details and known limitations.
Getting Started
-
Starting the server
Start achieve with HTTP, HTTPS, or HTTP/2, choose the application location, and run multiple listeners.
-
Static content and audio/video
Serve static resources and audio/video, work with MIME types, and use default index files.
-
Your first servlet
Servlets are the entry points to your backend processes, invoked by the server.
-
Handling Input
Read GET parameters, process POST forms and JSON, and work with streamed request data.
Detailed References
-
Configuration
Configure the application space, development and production modes, caching, compression, logging, MIME types, routing, HTTP methods, and CORS.
-
Routing
How Achieve maps request URLs to application resources, including application-space selection, exact route mappings, and subtree mappings.
-
Static Resources
Serve files and media with MIME types, caching, conditional requests, byte ranges, compression, and HEAD responses.
-
HTTP Methods
Use GET, HEAD, POST, and OPTIONS, and register servlet handlers for additional HTTP methods.
-
Backend: JavaScript Servlets
Write server-side JavaScript using Achieve's servlet model, with CommonJS and ESM support, request parameters, backend modules, asynchronous processing, and managed responses.
-
The Servlet Session Object
Reference for the request, response, parameters, module loading, response ownership, and application and servlet paths available through the servlet session.
Technical Specifications
-
Technical specifications and HTTP conformance assessment
Read focused descriptions of Achieve's behavior and the qualified standards assessment, including documented nonconformances and unverified requirements.
Examples
The Achieve 3 Advanced Examples provide a complete, ready-to-run development environment for newcomers, students, teachers, and experienced developers. The six demonstrations cover MySQL, WebSockets and Rooms, Node clustering, XML/SAX streaming, distributed computing, and SOAP services.
The final distribution installs Achieve 3 and its supporting packages from
npm. Choose a location and extract the ZIP, open a terminal in the resulting
achieve_examples directory, and run:
npm install
npm start
Then visit http://localhost:8989/.
The included INSTALL.htm provides additional instructions,
specialized startup commands, and the optional MySQL setup.
Download the Achieve 3 Advanced Examples ZIP