diff --git a/.editorconfig b/.editorconfig index 59d9a3a..3d9a482 100644 --- a/.editorconfig +++ b/.editorconfig @@ -3,8 +3,8 @@ root = true [*] charset = utf-8 -indent_style = space -indent_size = 2 +indent_style = tab +indent_size = 4 insert_final_newline = true trim_trailing_whitespace = true diff --git a/.fleet/run.json b/.fleet/run.json deleted file mode 100644 index 32bf4cf..0000000 --- a/.fleet/run.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "configurations": [ - { - "type": "command", - "name": "Run", - "program": "npm.exe", - "args": ["run", "start"] - }, - - ] -} \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 77b3745..0000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=827846 - "recommendations": ["angular.ng-template"] -} diff --git a/.vscode/launch.json b/.vscode/launch.json deleted file mode 100644 index 740e35a..0000000 --- a/.vscode/launch.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 - "version": "0.2.0", - "configurations": [ - { - "name": "ng serve", - "type": "pwa-chrome", - "request": "launch", - "preLaunchTask": "npm: start", - "url": "http://localhost:4200/" - }, - { - "name": "ng test", - "type": "chrome", - "request": "launch", - "preLaunchTask": "npm: test", - "url": "http://localhost:9876/debug.html" - } - ] -} diff --git a/.vscode/tasks.json b/.vscode/tasks.json deleted file mode 100644 index a298b5b..0000000 --- a/.vscode/tasks.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - // For more information, visit: https://go.microsoft.com/fwlink/?LinkId=733558 - "version": "2.0.0", - "tasks": [ - { - "type": "npm", - "script": "start", - "isBackground": true, - "problemMatcher": { - "owner": "typescript", - "pattern": "$tsc", - "background": { - "activeOnStart": true, - "beginsPattern": { - "regexp": "(.*?)" - }, - "endsPattern": { - "regexp": "bundle generation complete" - } - } - } - }, - { - "type": "npm", - "script": "test", - "isBackground": true, - "problemMatcher": { - "owner": "typescript", - "pattern": "$tsc", - "background": { - "activeOnStart": true, - "beginsPattern": { - "regexp": "(.*?)" - }, - "endsPattern": { - "regexp": "bundle generation complete" - } - } - } - } - ] -} diff --git a/README.md b/README.md index e259bed..e44828f 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,70 @@ -# Hacknet + +
+
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.0.2. + + Logo -## Development server + + ### Hacknet -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. + + Experimental Hacking Game -## Code scaffolding + + [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet/tags&query=$[0].name)](https://git.zakscode.com/ztimson/hacknet/tags) + [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet&query=open_pr_counter)](https://git.zakscode.com/ztimson/hacknet/pulls) + [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet&query=open_issues_count)](https://git.zakscode.com/ztimson/hacknet/issues) -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. + --- + +
+ Release Notes + • Report a Bug + • Request a Feature +
-## Build + --- +
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. +## Table of Contents +- [Hacknet](#top) + - [About](#about) + - [Built With](#built-with) + - [Setup](#setup) + - [Development](#development) + - [License](#license) -## Running unit tests +## About -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). +Hacknet is an experimental game written in Typescript meant to provide a virtual networked environment one can hack. -## Running end-to-end tests +The game provides a console and it is up to users to write their own scripts using the provided API to engage with the environment. -Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. +### Built With +[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/) +[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/) -## Further help +## Setup -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page. +
+ +

+ Development +

+ + +#### Prerequisites +- [Node.js](https://nodejs.org/en/download) + +#### Instructions +1. Install the dependencies: `npm install` +2. Start the Angular server: `npm run start` +3. Open [http://localhost:4200](http://localhost:4200) + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information. diff --git a/angular.json b/angular.json index 118ab2f..dc6c2c2 100644 --- a/angular.json +++ b/angular.json @@ -23,7 +23,7 @@ "polyfills": [ "zone.js" ], - "tsConfig": "tsconfig.app.json", + "tsConfig": "tsconfig.json", "inlineStyleLanguage": "scss", "assets": [ "src/favicon.ico", @@ -72,31 +72,6 @@ } }, "defaultConfiguration": "development" - }, - "extract-i18n": { - "builder": "@angular-devkit/build-angular:extract-i18n", - "options": { - "browserTarget": "Hacknet:build" - } - }, - "test": { - "builder": "@angular-devkit/build-angular:karma", - "options": { - "polyfills": [ - "zone.js", - "zone.js/testing" - ], - "tsConfig": "tsconfig.spec.json", - "inlineStyleLanguage": "scss", - "assets": [ - "src/favicon.ico", - "src/assets" - ], - "styles": [ - "src/scss/styles.scss" - ], - "scripts": [] - } } } } diff --git a/src/assets/.gitkeep b/src/assets/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/tech-icon.png b/src/assets/logo.png similarity index 100% rename from tech-icon.png rename to src/assets/logo.png diff --git a/src/favicon.ico b/src/favicon.ico deleted file mode 100644 index 997406a..0000000 Binary files a/src/favicon.ico and /dev/null differ diff --git a/tsconfig.app.json b/tsconfig.app.json deleted file mode 100644 index 374cc9d..0000000 --- a/tsconfig.app.json +++ /dev/null @@ -1,14 +0,0 @@ -/* To learn more about this file see: https://angular.io/config/tsconfig. */ -{ - "extends": "./tsconfig.json", - "compilerOptions": { - "outDir": "./out-tsc/app", - "types": [] - }, - "files": [ - "src/main.ts" - ], - "include": [ - "src/**/*.d.ts" - ] -} diff --git a/tsconfig.json b/tsconfig.json index ed966d4..ec5b43c 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -29,5 +29,11 @@ "strictInjectionParameters": true, "strictInputAccessModifiers": true, "strictTemplates": true - } + }, + "files": [ + "src/main.ts" + ], + "include": [ + "src/**/*.d.ts" + ] } diff --git a/tsconfig.spec.json b/tsconfig.spec.json deleted file mode 100644 index be7e9da..0000000 --- a/tsconfig.spec.json +++ /dev/null @@ -1,14 +0,0 @@ -/* To learn more about this file see: https://angular.io/config/tsconfig. */ -{ - "extends": "./tsconfig.json", - "compilerOptions": { - "outDir": "./out-tsc/spec", - "types": [ - "jasmine" - ] - }, - "include": [ - "src/**/*.spec.ts", - "src/**/*.d.ts" - ] -}