Giter Club home page Giter Club logo

wollok-ts's Introduction

Wollok-TS Build Status

TypeScript based Wollok language implementation

Usage

[[TODO]]

  • modules description
  • examples

Contributing

All contributions are welcome! Feel free to report issues on the project's issue tracker, or fork the project and create a Pull Request. If you've never collaborated with an open source project before, you might want to read this guide.

If you plan to contribute with code, here are some hints to help you start:

Working Environment

Before anything else, you will need a TypeScript editor. We recomend Visual Studio Code along with the following plugins:

You might also want to copy the following configurations to your user settings (ctrl+,):

  "window.menuBarVisibility": "default",
  "workbench.activityBar.visible": false,
  "workbench.startupEditor": "none",
  "explorer.openEditors.visible": 0,
  "files.exclude": {
    "dist": true,
    ".vscode": true,
    "node_modules": true,
  },
  "git.enabled": false,
  "editor.tabSize": 2,
  "explorer.autoReveal": true,
  "editor.formatOnSave": true,
  "tslint.autoFixOnSave": true,
  "tslint.alwaysShowStatus": true,
  "workbench.statusBar.feedback.visible": false,
  "window.zoomLevel": 0,
  "workbench.colorTheme": "Visual Studio Dark",
  "typescript.updateImportsOnFileMove.enabled": "always",
  "editor.foldingStrategy": "indentation",

NPM

You will also need to install NPM. If you are not familiar with dependency manager tools, you can think of this program as the entry point for all the important tasks development-related tasks, like installing dependencies and running tests. After installing the client, go to the project root folder and run:

# This will install all the project dependencies. Give it some time.
npm install

After that, you are ready to start working. You can run the tests and style checks by typing:

# This will run tests for all the modules. Try to do this often and avoid commiting changes if any test fails.
npm test

A full list of the available scripts is listed on the package.json file, on the root folder.

File Description

[[TODO]]: Describe what is each file

Dependencies

[[TODO]]: Describe what we are usinng, give links, and explain what docs to read based on what you will be touching.

wollok-ts's People

Contributors

nscarcella avatar kalafuente avatar

Watchers

Germán Leiva 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.