Git Product home page Git Product logo

cookiecutter-openedx-plugin's Introduction

This is a cookiecutter template for new Open edX plugins.

It enables creation of the plugin with the best practices we at eduNEXT have compiled over time.

We talk about it here:

Usage

To create a new plugin+ using this cookiecutter template, first make sure you have cookiecutter installed.

Then run:

$ cookiecutter https://github.com/eduNEXT/cookiecutter-openedx-plugin.git

Enter the variables when prompted.

  • project_desc -> human readable description of your plugin
  • package_name -> python package name. You can use _ for spaces
  • project_slug -> Normally also the repo name. You can use - or _ for spaces
  • class_name -> used when defining the app config python class

Once the openedx plugin is initialized, you should run in the root of the plugin `make upgrade` in order to generate the .txt requirements files used in the tests and for local development.

cookiecutter-openedx-plugin's People

Contributors

felipemontoya avatar squirrel18 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

edutech-groove

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.