Giter VIP home page Giter VIP logo

corewar.io's Introduction

Corewar

Node.js CI Documentation Status

Corewar

Typescript / Javascript implementation of the classic game corewar

Currently this project contains a corewar IDE, redcode parser and core simulator.

In future we hope to include local and remote hills and benchmarks and possibly to begin extending corewar itself.

This is the monorepo for the corewar.io project and contains the following packages:

  • corewar - npm package providing parser and simulator
  • corewar-ui - corewar.io user interface implemented as a spa
  • corewar-api - corewar.io api implemented in graphql

Documentation for the project along with guidance on corewar and the redcode language can be found on Read the Docs

Scripts

This project uses lerna in order to manage the monorepo. Node 12+ is required.

Prepare development environment

npm install --global lerna eslint-cli
npm run bootstrap

Currently lerna boostrap command is not building the corewar library. Documentation says it should automatically execute prepublish on all bootstrapped libraries but doesn't. In order to successfully bootstrap this application it is necessary to manually execute lerna run prepublish following bootstrap. I don't know why. If anyone knows, please let me know!

Start API and UI

npm start

Build UI and Core library

npm run build

Lint and test all packages

Linting and testing are performed by eslint and jest.

npm run lint
npm test

Automatically fix linting errors with

npm run lint:fix

Produce code coverage report with

npm run coverage

corewar.io's People

Contributors

dougajmcdonald avatar gareththegeek avatar obsttube avatar msylvia avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.