Code Monkey home page Code Monkey logo

create-axoncore-app's Introduction

create-axoncore-app

This repo hosts a boilerplate for an AxonCore app.

DISCLAIMER:
This boilerplate is strongly opiniated about the way you should use AxonCore.
AxonCore was designed to be used with such a file organisation and structure, however feel free to organise your application the way you want.


Setup

By doing:

  • npm init axoncore-app
  • yarn create axoncore-app You can create a default boilerplate with all necessary files and folder organisation to build really fast an AxonCore bot. Due to an issue with Yarn, the boilerplate will error out when you try to use it. Please click here for more details. You will still be able to use NPM to complete setup.

You can pass several options, all of them are optional:

  • --lib, --library or -l: to specify the library you want to use. eris, discordjs.
  • --type or -t: to specify the module system you want to use. commonjs, esm, typescript / ts.

Any options you do not specify will be prompted for you to select.

Examples

yarn create axoncore-app --lib eris
yarn create axoncore-app -l discordjs --type esm
npm init axoncore-app -t commonjs
npm init axoncore-app


Contributions

Feel free to contribute to improve this boilerplate. It has the purpose to be simple but to contain all default files and structure needed.

create-axoncore-app's People

Contributors

bsian03 avatar dependabot[bot] avatar khaaz avatar

Watchers

 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.