Skip to content

Commit b396981

Browse files
committed
Update readme
1 parent db0768c commit b396981

File tree

1 file changed

+15
-26
lines changed

1 file changed

+15
-26
lines changed

README.md

+15-26
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,42 @@ usage. The purpose of this Starter Kit is to show simplicity, basic concepts,
77
give structure and architecture examples. All parts of this implementation are
88
optimized for readability and understanding, but not for performance and
99
scalability.
10+
1011
So it is good for development and education. However, for production deployment,
11-
you may need the [Metarhia Example App](https://github.com/metarhia/Example)
12-
(it will be released in the middle of July 2020). After your application is
13-
ready, you can easily run it in the
14-
[Metaserverless cloud](https://github.com/Metaserverless), an open source cloud
15-
platform based on [Metarhia technology stack](https://github.com/metarhia) and
16-
[Node.js](https://nodejs.org/en/).
12+
you may need the [Metarhia Example App](https://github.com/metarhia/Example) an
13+
open-source application server on the top of [Node.js](https://nodejs.org/en/).
1714

1815
## Feature list
1916

20-
- Serve API with auto-routing, HTTP(S), WS(S)
21-
- Server code live reload with file system watch
22-
- Graceful shutdown and application reload
17+
- Pure node.js and framework-agnostic approach
2318
- Minimum code size and dependencies
19+
- Layered architecture: core, domain, API, client
20+
- Protocol-agnostic API with auto-routing, HTTP(S), WS(S)
21+
- Graceful shutdown
2422
- Code sandboxing for security, dependency injection and context isolation
25-
- Multi-threading for CPU utilization and isolation
26-
- Serve multiple ports in threads
23+
- Serve multiple ports
2724
- Serve static files with memory cache
2825
- Application configuration
29-
- Simple logger and redirection from a console
26+
- Simple logger
3027
- Database access layer (Postgresql)
31-
- Persistent sessions (stored in DB)
28+
- Persistent sessions
3229
- Unit-tests and API tests example
3330
- Request queue with timeout and size
3431
- Execution timeout and error handling
35-
- Layered architecture: core, domain, API, client
36-
37-
## Features to be implemented in the next release
38-
39-
- Load balancing for scaling
40-
- Prototype pollution prevention
41-
- Multiple IDEs support
42-
- Better testing
4332

4433
## Requirements
4534

46-
- Node.js v12.9.0 or later (v14 preferred)
47-
- Linux (tested on Fedora 30, Ubuntu 16, 18, 19 and 20, CentOS 7 and 8)
48-
- Postgresql 9.5 or later (v11.8 preferred)
35+
- Node.js v16 or later
36+
- Linux (tested on Fedora, Ubuntu, and CentOS)
37+
- Postgresql 9.5 or later (v12 preferred)
4938
- OpenSSL v1.1.1 or later
5039
- [certbot](https://github.com/certbot/certbot) (recommended but optional)
5140

5241
## Usage
5342

5443
1. Fork and clone this repository (optionally subscribe to repo changes)
5544
2. Remove unneeded dependencies if your project doesn't require them
56-
3. Run `npm install` to install dependencies and generate certificate
45+
3. Run `npm ci --production` to install dependencies and generate certificate
5746
4. Add your license to `LICENSE` file but don't remove starter kit license
5847
5. Start your project by modifying this starter kit
5948
6. Run project with `node server.js` and stop with Ctrl+C
@@ -65,5 +54,5 @@ Ask questions at https://t.me/nodeua and post issues on
6554

6655
## License
6756

68-
Copyright (c) 2020 How.Programming.Works contributors.
57+
Copyright (c) 2020-2022 How.Programming.Works contributors.
6958
This starter kit is [MIT licensed](./LICENSE).

0 commit comments

Comments
 (0)