Welcome to Squid SSR! This framework is heavily inspired by Next.js but designed to be less restricting with the backend.
In essence, Squid is just an Express middleware that takes care of the routing and parsing of dynamic routes. Every page will be compiled into an independent JavaScript bundle. Files that end with '.ts' instead of '.tsx' will be handled as API endpoints.
To initiliase a Squid project, you can use npm :
npm init squid-ssr
Like in Next.js, the routing of your page will reflect the structure of the pages directory. You can create dynamic paths by using curly braces:
// src/pages/@{user}.tsx
import { h, Fragment } from 'preact';
import {Request, Response} from 'express';
export function getServerSideProps(req:Request, _res:Response) {
return {
props: {
//parameters from dynamic paths will be made available in the Request.params object
name: req.params.user
}
};
}
type Props = {
} & ReturnType<typeof getServerSideProps>['props']
export default function App({name}:Props) {
return <>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Home of {name}</title>
</head>
<body>
<span>This is {name}'s page!</span>
</body>
</html>
</>;
}
It works the same for API endpoints.
The entrypoint for a Squid application will always be under src/main.ts and might look like the following:
import express from 'express';
import squid from 'squid-ssr';
import cookieParser from 'cookie-parser'; //3rd party middleware for cookie parsing
const port = Number.parseInt(process.env.SQUID_PORT ?? '0') || 3000;
const app = express();
// http://expressjs.com/en/advanced/best-practice-security.html#at-a-minimum-disable-x-powered-by-header
app.disable('x-powered-by');
app.use(cookieParser());
app.use(squid());
app.get('*', (_req, res) => {
res.status(404).send('Page not found');
});
app.listen(port, () => {
console.log(`✅ Express server listening on port ${port}`);
});
Still being made (maybe ¯\(ツ)/¯ ).
Squid SSR is open-source software licensed under the MIT license.
I would like to express my thanks to the following projects and communities that have greatly inspired and influenced Squid SSR:
If you have any questions, suggestions, or feedback, please feel free to contact me at nilsramstoeck@gmail.com.
FAQs
Preact SSR Framework
We found that squid-ssr demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.