Skip to content

Commit

Permalink
Dotfiles and repo configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
tshemsedinov committed Apr 24, 2022
1 parent 39b4966 commit dc734c1
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 85 deletions.
1 change: 0 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
.npmignore
.eslintignore
.editorconfig
.travis.yml
test
node_modules
LICENSE
Expand Down
1 change: 0 additions & 1 deletion .github/FUNDING.yml

This file was deleted.

14 changes: 0 additions & 14 deletions .travis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020-2022 Metarhia contributors
Copyright (c) 2022 B-OS and Metarhia contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
40 changes: 9 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,12 @@
# Metarhia Example Server for Node.js
# B-OS Demo Application

[![travis](https://travis-ci.org/metarhia/impress.svg?branch=master)](https://travis-ci.org/metarhia/Example)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/metarhia/Example/blob/master/LICENSE)
- Technology stack: Node.js, Metarhia
- Database management system: PostgreSQL
- Frontend stack: vanilla.js

## Concept

This is a logical continuation of
[Node.js Starter Kit](https://github.com/HowProgrammingWorks/NodejsStarterKit)
from [How Programming Works](https://github.com/HowProgrammingWorks) software
development course moving all system code to dependencies, namely using
[Metarhia technology stack](https://github.com/metarhia).

You can begin development from this starter kit but having in mind future
production deployment and further moving application to
[Metaserverless cloud](https://github.com/Metaserverless) based on Metarhia
technology stack and Node.js.
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/b-os-tech/Demo/blob/master/LICENSE)

The purpose of this starter kit is to show best practices for Metarhia and
Metaserverless, to give structure and architecture example, to illustrate
simplicity and efficiency of mentioned technologies.

All parts of this implementation are optimized for reliability, scalability,
performance and security. So if you need readability and want to study code,
let's start with
[Node.js Starter Kit](https://github.com/HowProgrammingWorks/NodejsStarterKit).
## Concept

## Feature list

Expand All @@ -50,20 +33,15 @@ let's start with

## Usage

- You need node.js v12.5.0 or later (v14 prefered)
- Fork and clone this repository (optionally subscribe to repo changes)
- You need node.js v14 or later (v16 prefered)
- Clone this repository (optionally subscribe to repo changes)
- Run `npm i` to install dependencies and generate RSA certificate
- Remove unneeded dependencies if your project doesn't require them
- Add your license to `LICENSE` file but don't remove starter kit license
- Start your project modifying this starter kit
- Before running server initialize the DB:
- First of all, make sure you have PostgreSQL installed (prefer 12.x).
- Run database initialization script: `db/setup.sh`
- Run project: `node server.js` and stop with Ctrl+C
- Ask questions in https://t.me/nodeua and post issues on
[github](https://github.com/HowProgrammingWorks/NodejsStarterKit/issues)

## License

Copyright (c) 2020-2022 Metarhia contributors.
Copyright (c) 2022 B-OS and Metarhia contributors.
This starter kit is [MIT licensed](./LICENSE).
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 7 additions & 35 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,45 +1,17 @@
{
"name": "metarhia",
"version": "2.0.1",
"name": "b-os-demo",
"version": "0.1.0",
"author": "Timur Shemsedinov <timur.shemsedinov@gmail.com>",
"description": "Metarhia Application Example",
"description": "B-OS Demo Application",
"license": "MIT",
"keywords": [
"metarhia",
"starter",
"kit",
"cloud",
"impress",
"nodejs",
"example",
"websocket",
"api",
"application",
"server",
"rpc",
"soa",
"service",
"stateful",
"rest",
"restful",
"web",
"framework",
"router",
"routing",
"cluster",
"cache",
"http",
"https",
"websockets"
],
"repository": {
"type": "git",
"url": "https://github.com/metarhia/Example"
"url": "https://github.com/b-os-tech/Demo"
},
"bugs": {
"url": "https://github.com/metarhia/Example/issues"
"url": "https://github.com/b-os-tech/Demo/issues"
},
"homepage": "https://github.com/metarhia/Example",
"homepage": "https://github.com/b-os-tech/Demo",
"main": "server.js",
"types": "types/global.d.ts",
"scripts": {
Expand All @@ -50,7 +22,7 @@
"db": "metasql c"
},
"engines": {
"node": "^12.9 || 14 || 16 || 17"
"node": "14 || 16 || 18"
},
"devDependencies": {
"@types/node": "^17.0.21",
Expand Down

0 comments on commit dc734c1

Please sign in to comment.