{"id":15511898,"url":"https://github.com/VulcanJS/Vulcan-Starter","last_synced_at":"2025-10-12T08:32:14.347Z","repository":{"id":25993836,"uuid":"105245801","full_name":"VulcanJS/Vulcan-Starter","owner":"VulcanJS","description":"VulcanJS starter repo. Use as a base for your own VulcanJS projects.","archived":false,"fork":false,"pushed_at":"2023-01-06T01:46:52.000Z","size":5757,"stargazers_count":127,"open_issues_count":74,"forks_count":88,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-01-16T17:23:20.379Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VulcanJS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-29T07:57:53.000Z","updated_at":"2023-08-25T23:46:35.000Z","dependencies_parsed_at":"2022-07-10T13:30:25.037Z","dependency_job_id":null,"html_url":"https://github.com/VulcanJS/Vulcan-Starter","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2FVulcan-Starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2FVulcan-Starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2FVulcan-Starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VulcanJS%2FVulcan-Starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VulcanJS","download_url":"https://codeload.github.com/VulcanJS/Vulcan-Starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236188361,"owners_count":19109394,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T09:53:17.157Z","updated_at":"2025-10-12T08:32:08.799Z","avatar_url":"https://github.com/VulcanJS.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\n# Vulcan Starter\n\nThis kit gives you all you need to quickly learn Vulcan and launch your own projects.\n\nOther resources: \n\n- [Vulcan Docs](http://docs.vulcanjs.org)\n- [Vulcan Slack](http://slack.vulcanjs.org)\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n**Table of Contents**\n\n- [Quick Install](#quick-install)\n    - [Step 1 - Clone](#step-1---clone)\n    - [Step 2 – Run](#step-2--run)\n- [Getting Started Tutorial](#getting-started-tutorial)\n- [Other Examples](#other-examples)\n- [Complete Install](#complete-install)\n    - [Critical prerequisite](#critical-prerequisite)\n    - [Step 1 - Preparation](#step-1---preparation)\n    - [Step 2 - Test Vulcan installation](#step-2---test-vulcan-installation)\n    - [Step 3 - Prepare your project](#step-3---prepare-your-project)\n    - [Step 4 - Test your project installation](#step-4---test-your-project-installation)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Quick Install\n\nIf you already have Meteor up and running, read this section. Otherwise, read the [Complete Install](#complete-install) section.\n\n#### Step 1 - Clone\n\n```\ngit clone git@github.com:VulcanJS/Vulcan-Starter.git\ncd Vulcan-Starter\n```\n\n(or, using `https`: `git clone https://github.com/VulcanJS/Vulcan-Starter.git`)\n\n#### Step 2 – Run\n\n```\nnpm install\nnpm start\n```\n\n## Getting Started Tutorial\n\nWhen you first run this repo, you'll see the first step of Vulcan's interactive Getting Started tutorial. \n\n![https://d3vv6lp55qjaqc.cloudfront.net/items/0I2W3G1i2K3z0p052c02/Screen%20Shot%202018-02-03%20at%2011.16.53.png?X-CloudApp-Visitor-Id=43642\u0026v=807ac6f9](https://d3vv6lp55qjaqc.cloudfront.net/items/0I2W3G1i2K3z0p052c02/Screen%20Shot%202018-02-03%20at%2011.16.53.png?X-CloudApp-Visitor-Id=43642\u0026v=807ac6f9)\n\nThis interactive tutorial will guide you through Vulcan basics, such as:\n\n- Creating routes.\n- Registering components.\n- Defining a schema.\n- Loading data.\n- Generating forms.\n\nAll while modifying the code of the tutorial itself! How meta!\n\n## Other Examples\n\nAdditionally, this repo also contains the following example apps: \n\n- **Simple Example**: build a simple paginated list of movies [[video]](http://docs.vulcanjs.org/example-simple.html).\n- **Movies Example**: like the Simple example, but more in-depth [[video+tutorial]](http://docs.vulcanjs.org/example-movies.html). \n- **Permissions Example**: manage user roles in Vulcan [[video]](http://docs.vulcanjs.org/example-permissions.html).\n- **Instagram Example**: create a simple Instagram clone [[video]](http://docs.vulcanjs.org/example-instagram.html).\n- **Interfaces Example**: using GraphQL interfaces.\n- **Reactions Example**: implement Facebook-style reactions \u0026 voting.\n- **Forum Example**: a full-fledged Hacker News-style forum codebase [[docs]](http://docs.vulcanjs.org/example-forum.html). \n- **Customization Example**: how to customize other Vulcan packages, based on the Forum Example [[video+tutorial]](http://docs.vulcanjs.org/example-customization.html). \n\n## Complete Install\n\nThe *Complete Install* steps will get you going on a freshly built Ubuntu desktop machine (including installing Node, Meteor, etc.) using the \"[two-repo](http://docs.vulcanjs.org/#Two-Repo-Install)\" install.\n\nThe steps below assume a machine that has not previously been used for software development.\n\nThey were tested Oct 15/2017, on an 8Gb Qemu/KVM virtual machine running a freshly installed Xubuntu Desktop 16.04 LTS.\nExpect other environments to behave differently but, sufficiently similar that, adaptation should not be difficult.\n\n#### Critical prerequisite\n\nNote that, to use the scripts below, you **must already have** SSH access to GitHub.  You'll need that in any case for properly managing version control of your project.  Learn more at [GiHub Bootcamp : Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)\n\n#### Step 1 - Preparation\n\n    # Specify where things should go\n    export NEW_PROJECT_NAME=\"myVulcan\";                # a name for your new project\n    export PROJECTS_DIRECTORY=\"${HOME}/projects\";      # the installation path for your new project\n    export VULCAN_HOME=\"${PROJECTS_DIRECTORY}/Vulcan\"; # the path to the root of your Vulcan installation\n\n    # Prepare dependencies\n    sudo apt install -y git curl build-essential;\n    # Need git for managing your project's source code.\n    # Need curl to get the other stuff.\n    # Need C++ build tools for fast bcrypt installation\n\n    # Install 'meteor'\n    curl https://install.meteor.com/ | sh;\n\n    # Sanity check your Meteor installation\n    echo -e \"\\nMeteor version...\";\n    meteor --version;\n    export METEOR_NODE_VERSION=$(meteor node --version);\n    echo -e \"Meteor Node version...\\n ${METEOR_NODE_VERSION}\";\n\n\n    # Install 'nvm', so as to be able to easily switch NodeJs versions\n    curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash;\n\n    # Prepare to use 'nvm' immediately\n    export NVM_DIR=\"$HOME/.nvm\"\n    [ -s \"$NVM_DIR/nvm.sh\" ] \u0026\u0026 \\. \"$NVM_DIR/nvm.sh\"  # This loads nvm\n    [ -s \"$NVM_DIR/bash_completion\" ] \u0026\u0026 \\. \"$NVM_DIR/bash_completion\"  # This loads nvm bash_completion\n\n\n    # Set Meteor version of Node as your default for NodeJS work outside of Meteor\n    nvm install ${METEOR_NODE_VERSION};\n    nvm alias default ${METEOR_NODE_VERSION};\n\n    # Create a projects folder and step into it\n    mkdir -p ${PROJECTS_DIRECTORY}\n    cd ${PROJECTS_DIRECTORY}\n\n    # Clone Vulcan core into its own folder and step into it\n    git clone git@github.com:VulcanJS/Vulcan.git\n\n    # install and pre-cache all of Vulcan's NodeJS dependencies\n    cd ${VULCAN_HOME};\n    meteor npm install;\n\n#### Step 2 - Test Vulcan installation\n\n Check it works with a browser at http://localhost:3033\n then kill it with \u0026lt;ctrl-c\u003e\n\n    # Run Vulcan so it pre-caches all its Meteor dependencies\n    [ -f settings.json ] || cp sample_settings.json settings.json;\n    meteor  --port 3033 --settings settings.json;\n\n\n#### Step 3 - Prepare your project\n\n    cd ${PROJECTS_DIRECTORY};\n    \n    # Clone Vulcan starter kit as your named project\n    git clone git@github.com:VulcanJS/Vulcan-Starter.git ${NEW_PROJECT_NAME}\n\n    # Step in your project folder\n    cd ${NEW_PROJECT_NAME};\n\n    # Make sure your app uses the same Meteor release as Vulcan\n    cp ${VULCAN_HOME}/.meteor/release ./.meteor;\n\n    # install and pre-cache all of your named app's NodeJS dependencies\n    # meteor npm install --save cross-fetch;\n    meteor npm install;\n\n    # Tell Meteor to refer to the Vulcan sister folder for packages that Vulcan supplies\n    export METEOR_PACKAGE_DIRS=../Vulcan/packages;\n    echo \"Vulcan's Meteor packages folder : ${METEOR_PACKAGE_DIRS}.\";\n\n#### Step 4 - Test your project installation\n\n Check it works with a browser at http://localhost:3000\n then kill it with \u0026lt;ctrl-c\u003e\n\n    # Run your Vulcan project\n    [ -f settings.json ] || cp sample_settings.json settings.json;\n    meteor --port 3000 --settings settings.json\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVulcanJS%2FVulcan-Starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FVulcanJS%2FVulcan-Starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVulcanJS%2FVulcan-Starter/lists"}