Skip to content

Commit ece2570

Browse files
Initial Commit
1 parent bfef972 commit ece2570

16 files changed

+5903
-0
lines changed

.babelrc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"sourceMaps": true,
3+
"presets": [
4+
"@babel/preset-typescript",
5+
[ "@babel/preset-env", {
6+
"targets": {
7+
"node": "13"
8+
},
9+
"modules": "commonjs"
10+
} ]
11+
],
12+
"plugins": [
13+
"@babel/plugin-proposal-class-properties",
14+
[ "babel-plugin-module-resolver", {
15+
"root": [ "./src" ],
16+
"alias": {
17+
"@server": "./dist"
18+
}
19+
} ]
20+
]
21+
}

.gitignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
node_modules
2+
.DS_Store
3+
/dist
4+
/cache
5+
server-config.yaml
6+
7+
# local env files
8+
.env.local
9+
.env.*.local
10+
11+
# Log files
12+
npm-debug.log*
13+
yarn-debug.log*
14+
yarn-error.log*
15+
16+
# Editor directories and files
17+
.idea
18+
.vscode
19+
*.suo
20+
*.ntvs*
21+
*.njsproj
22+
*.sln
23+
*.sw?

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to RuneJS
2+
3+
RuneJS was created with the intention of utilizing JavaScript/TypeScript and Node's innovative features. RxJS was imported for reactive programming as well, opening up opportunities for easy content development. As such, there are a few things we're looking to avoid...
4+
5+
1. Direct ports/copying from Java servers
6+
- This defeats the purpose of RuneJS by implementing basic flows that any regular Java-based server would use. Think outside the box and really utilize ES6, TypeScript, Node, and RxJS! :)
7+
2. Additional/outside dependencies
8+
- Sometimes additional dependencies cannot be avoided, but we'd like to avoid them as much as possible. RuneJS intends to be simple and easy for anyone to pick up, without requiring the user to set up any databases or additional third party systems.
9+
- In some cases this is of course unavoidable, as such we'll handle them on a case-by-case basis.
10+
11+
Ultimately if you're looking to contribute, it's best to check in with us on Discord to see if we're already working on a specific feature or have plans for it already. Add us at **TheBlackParade#1260**
12+
13+
## Code Style
14+
15+
We do have a few coding styles and lint rules we'd like all contributors to adhere to. **Please run the linter via `npm run lint` before submitting any Pull Requests**:
16+
17+
- 4 space indentation
18+
- Spaces between TS/ES6 import/export braces
19+
- `import { this } from 'that';` instead of `import {this} from 'that';`
20+
- Semicolon line endings
21+
- `let myVariable = true;` instead of only `let myVariable = true`
22+
- Single quotes instead of double quotes
23+
- `let myString = 'hello world!';` instead of `let myString = "hello world";`
24+
- `import { this } from 'that';` instead of `import { this } from "that";`
25+
- Avoid the `var` keyword
26+
- `let myVariable;` instead of `var myVariable;`
27+
- Prefer `const` to `let`
28+
- If a variable is never going to be modified, please declare it using `const` instead of `let`
29+
- `const neverChanged = true;` instead of `let neverChanged = true;`
30+
- Add types to all method parameters and return types to all methods
31+
- `public myMethod(firstParam: string, secondParam: number): void {` instead of `public myMethod(firstParam, secondParam) {`
32+
- Add `public`, `private`, or `protected` to every class variable or method
33+
- `public myMethod(): void {` instead of `myMethod(): void {`
34+
- `private myVar: number;` instead of `myVar: number;`
35+
- Use TypeScript getters/setters instead of specific getter/setter methods
36+
- `public get myVar(): number` instead of `public getMyVar(): number`
37+
- `public set myVar(myVar: number)` instead of `public setMyVar(myVar: number)`

LICENSE

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
updateServerHost: '0.0.0.0'
2+
updateServerPort: 43592
3+
cacheDir: './cache'

nodemon.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"verbose": true,
3+
"watch": ["src/"],
4+
"ext": "ts, js"
5+
}

0 commit comments

Comments
 (0)