Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lixinyang123/plankton
Simple, Fast, Zero-dependency web framework for Node.js 🌐
https://github.com/lixinyang123/plankton
mvc nodejs webframework
Last synced: about 2 months ago
JSON representation
Simple, Fast, Zero-dependency web framework for Node.js 🌐
- Host: GitHub
- URL: https://github.com/lixinyang123/plankton
- Owner: lixinyang123
- License: mit
- Created: 2024-03-26T15:36:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-18T14:22:32.000Z (9 months ago)
- Last Synced: 2024-05-18T15:29:50.998Z (9 months ago)
- Topics: mvc, nodejs, webframework
- Language: JavaScript
- Homepage:
- Size: 79.1 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Plankton
[](https://github.com/lixinyang123/Plankton/actions/workflows/ci.yml)
[Plankton](https://www.npmjs.com/package/@lixinyang123/plankton) is a simple, fast, zero-dependency web framework for Node.js
#### Features
- Simple
- Fast
- Zero-dependency
- Small size
- Support mvc
- Built-in template engine
## Install
This is a [Node.js](https://nodejs.org/) module available through the [npm](https://www.npmjs.com/).
```bash
npm install @lixinyang123/plankton
# or
yarn add @lixinyang123/plankton
```
## Quick Start
You need create a nodejs project first.
```bash
yarn init
yarn add @lixinyang123/plankton
mkdir src
touch src/main.js
```
copy this code to `src/main.js`.
```javascript
import plankton from '@lixinyang123/plankton'
plankton()
.map('/', (req, res) => {
res.end('hello world')
})
.build()
.start()
```
Finally, you can launch your first web app.
```bash
node src/main.js
curl localhost:8080
```
## Usage
Here are some basic usages, You can find more in the [example](https://github.com/lixinyang123/Plankton/tree/main/example) folder.
#### Basic
```javascript
plankton().map('/', (req, res) => {
res.end('hello world')
}).build().start()
```
#### Group
```javascript
plankton().mapGroup('api', group => {
group.map('/', (req, res) => {
res.end('hello world')
})
}).build().start()
```
#### Middleware
- src/main.js
```javascript
import plankton from '@lixinyang123/plankton'
import TestMiddleware from './middlewares/test.js'
let app = plankton()
app.use(async (req, res, next) => {
console.log('middleware 1 start')
await next(req, res)
console.log('middleware 1 end')
})
app.use(TestMiddleware)
app.map('/', (req, res) => {
res.end('hello world')
})
app.build().start()
```
- src/middlewares/test.js
```javascript
export default async function (req, res, next) {
res.write('middleware 2 start')
await next(req, res)
res.write('middleware 2 end')
}
```
`curl localhost:8080`, You can see the output
```bash
middleware 1 start
middleware 2 start
middleware 2 end
middleware 1 end
```
#### MVC
- src/main.js
```javascript
plankton()
.mapController()
.build()
.start()
```
- src/controllers/home.js
```javascript
export default {
index: async (req, res) => {
await res.render('index.ejs', { action: 'index' })
},
about: async (req, res) => {
await res.render('about.ejs', { action: 'about' })
}
}
```
- src/views/index.ejs
```html
Hello world from action: <%= action %>
```
#### Layout
- src/views/_layout.ejs
```html
Example
Header
<%{{ content }}%>
Footer
```
- src/views/home/index.ejs
```html
<%{ '../_layout.ejs' }%>
<%{ content %>
<% for (let i = 0; i < 5; i++) { %>
Hello <%= world %>
<% } %>
<%} %>
```
- src/main.js
```javascript
plankton().map('/', async (req, res) => {
await res.render('index.ejs', { world: 'world' })
}).build().start()
```
#### StaticFile
```javascript
let app = plankton()
// map static file
app.useStaticFile()
app.useStaticFile('static', 'test')
app.map('/', (req, res) => {
res.redirect('/index.html')
})
app.build().start()
```
#### Cors
```javascript
plankton()
.useCors()
.map('/', (req, res) => {
res.end('hello world')
}).build().start()
```
#### Logger
```javascript
plankton()
.useLogger((msg, level) => {
// handler...
})
.map('/', (req, res) => {
res.end('hello world')
}).build().start()
```
#### Cookie
```javascript
plankton()
.map('/', (req, res) => {
res.cookie('hello', 'world')
res.end('hello world')
})
.map('/test', (req, res) => {
res.end('hello ' + req.cookie['hello'])
})
.build()
.start(8080)
```
> res.cookie(key, value, expires, path)
#### Session
```javascript
plankton()
.useSession(/* 1000 * 5 */)
.map('/', (req, res) => {
res.session.set('hello', 'world')
res.end('hello world')
})
.map('/test', (req, res) => {
res.end('hello ' + req.session.get('hello'))
})
.build()
.start(8080)
```
> default session expires is 30 mins