https://github.com/code-dot-org/maze

Standalone repo for the Maze app type
https://github.com/code-dot-org/maze

Last synced: 9 days ago
JSON representation

Standalone repo for the Maze app type

• Host: GitHub
• URL: https://github.com/code-dot-org/maze
• Owner: code-dot-org
• License: other
• Created: 2018-01-30T23:07:15.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2025-06-16T02:09:16.000Z (7 months ago)
• Last Synced: 2025-06-16T03:38:45.032Z (7 months ago)
• Language: JavaScript
• Homepage: https://code-dot-org.github.io/maze/
• Size: 1.38 MB
• Stars: 6
• Watchers: 29
• Forks: 3
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# maze

[![npm version](https://img.shields.io/npm/v/@code-dot-org/maze.svg)](https://www.npmjs.com/package/@code-dot-org/maze)

[![Travis Build Status](https://img.shields.io/travis/code-dot-org/maze.svg)](https://travis-ci.org/code-dot-org/maze/)

[![codecov](https://codecov.io/gh/code-dot-org/maze/branch/main/graph/badge.svg)](https://codecov.io/gh/code-dot-org/maze)

Standalone repo for the Maze app type

### Setup Your Project

Check this project out from source:

    git clone git@github.com:code-dot-org/maze.git

    cd maze

    

Next, inside the project, you need to install the project's various dependencies.

    yarn install

    

Now you should be able to run all the tests:

    yarn test

    

And spin up a development build of your new project:

    yarn build

### Integrate with local Code Studio

In this repo:

```

yarn link

```

In main repo's `apps/` directory:

```

yarn link @code-dot-org/maze

```

This will set up a symlink in main repo's apps/node_modules/ to point at your local changes.

Run

```

yarn run build

```

in this repo, and then the main repo's `apps` build should pick the changes up next time it builds.

If you are running `yarn start` for continuous builds in the main repo, it will pick up the changes once the build in this repo has completed.

### Publishing a new version

In /maze: npm login with an authorized npm account. If necessary, create one under your own email, login with our shared dev account and add your new account to the org. After logging in, you may need to authorize your machine (follow the prompt given):

    npm login

    npm adduser (if necessary)

Still in /maze: checkout main, and ensure it is up-to-date:

    git checkout main

    git pull

Verify the existing code doesn't have errors or failing tests:

    yarn build

    yarn test

Then, update the version (which also publishes to npm):

    npm version [major|minor|patch|premajor|preminor|prepatch].

Verify there is a new commit on /maze/main with the updated version number. 

In the @code-dot-org repo, incorporate the new version of maze: 

    git checkout -b [maze-updates-we-are-incorporating]

    cd apps

    yarn add @code-dot-org/maze@my.new.version (ex: yarn add @code-dot-org/maze@2.7.0)

 

Verify yarn.lock and package.json have been updated.

Commit and push changes, and open and merge a PR.