Skip to content
This repository was archived by the owner on Aug 12, 2021. It is now read-only.

Commit f5fb87e

Browse files
committed
first commit?
0 parents  commit f5fb87e

16 files changed

+7683
-0
lines changed

.gitignore

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.cache/
2+
.DS_Store
3+
dist/
4+
es/
5+
lib/
6+
documentation/
7+
node_modules/
8+
envs/*.env
9+
.vscode
10+
coverage/
11+
.ocp-port-forwarding.js

.npmignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
src
2+
documentation
3+
.gitignore
4+
rollup.config.js
5+
tsconfig.json
6+
tslint.json

Makefile

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.PHONY: build test clean
2+
3+
install:
4+
@echo "Installing project's dependencies... 🚀"
5+
@docker-compose run --rm nexus-sdk install
6+
7+
build:
8+
@echo "Building project... 👷"
9+
@docker-compose run --rm nexus-sdk
10+
11+
test:
12+
@echo "Running tests... 🧪"
13+
@docker-compose run --rm nexus-sdk test
14+
15+
lint:
16+
@echo "Linting... ✨"
17+
@docker-compose run --rm nexus-sdk run lint
18+
19+
documentation:
20+
@echo "Generating documentation... 📑"
21+
@docker-compose run --rm nexus-sdk run documentation
22+
23+
clean:
24+
@echo "Cleaning... 🧹"
25+
@docker-compose run --rm nexus-sdk run clean
26+
@sudo rm -fr node_modules/

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Wild Magix 🍄✨
2+
3+
🧙‍♀️ A Redux action and reducer set to manage Entities and Components
4+
5+
Meant to be used in tandem with Wild Magic, but could be used as a state manager for any ECS
6+
7+
> [Status](#status) |
8+
> [Development](#development) |
9+
> [License](#license)
10+
11+
## Status
12+
13+
⚠ Alpha! ⚠ Just like Wild Magic, the nature of this code is ever-shifting!
14+
15+
## Development
16+
17+
I recommend using docker, as you can get set up without having to worry about any dependencies, except for docker itself.
18+
19+
### With Docker
20+
21+
Make sure you have already installed both [Docker Engine](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/).
22+
23+
- Install: `make install`
24+
- Build: `make build`
25+
- Test: `make test`
26+
- Lint: `make lint`
27+
- Generate Documentation: `make documentation`
28+
29+
### With Node.js
30+
31+
- Install: `npm install`
32+
- Build: `npm run build`
33+
- Test: `npm run test`
34+
- Lint: `npm run lint`
35+
- Generate Documentation: `npm run documentation`
36+
37+
# License
38+
39+
- [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)

docker-compose.yaml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: '3'
2+
3+
services:
4+
nexus-sdk:
5+
image: node:11-slim
6+
working_dir: /app
7+
tty: true
8+
volumes:
9+
- .:/app
10+
entrypoint: npm
11+
command: ['run', 'build']

0 commit comments

Comments
 (0)