Getting Started
In order to develop core.io applications you will need to have Node.js and npm installed. You can follow instructions in the Node.js website to download and install these dependencies on your computer.
core.io is compromised of multiple modules each distributed as a Node.js package through npm or other package managers.
The fastest way to get up and running is by installing and using the core CLI tool which enables you to create new projects using the command line. You can read more about the core.io CLI tool in it's documentation page.
Writing documentation is hard, and keeping it up to date is also hard. If you come across a step that does not work as expected you could create an issue on github.
1. Install core.io cli tool belt:
Open a new terminal window and type the following command:
$ npm i -g core.io-cli
This will install core.io-cli and make the core command available in your terminal. To verify it was installed correctly, if you type core in your terminal you should see a help output.
$ core
core 0.0.3 - core.io CLI tool belt manager
USAGE
core <command> [options]
COMMANDS
shuttle install Install all dependencies. Needs sudo
shuttle list List all local domains
shuttle open <domain> Open domain in default browser
shuttle share <project> Generate a shareable URL for a project
shuttle restart Restart Caddy and Dnsmasq services
shuttle stop Stop Caddy and Dnsmasq services
shuttle start Start Caddy and Dnsmasq services
shuttle serve <domain> <proxy> Proxy a local domain and save it for quick access
shuttle update Update toolchain
generator add <source> [alias] Add a project template from github or a local directory
generator list List available templates
generator new <template> [output] Create a new project from a project template
generator link <source> [alias] Link local template for development
schema collect [source] [output] Collect metadata from waterline models and generates a JSON schema file
schema generate [source] [output] Generate schema from model data
scaffold compile [source] [output] Generate views from a GUI schema
scaffold generate [source] [output] Generate views from a JSON schema
run [application] [environment] Run a core.io application
repl Open REPL window
help <command> Display help for a specific command
GLOBAL OPTIONS
-h, --help Display help
-V, --version Display version
--no-color Disable colors
--quiet Quiet mode - only displays warn and error messages
-v, --verbose Verbose mode - will also output debug messages
2. Create a project
Once you have the tool belt installed, you can create a project from your terminal.
$ core generator new myProject
The generator will create a new folder for your application in your current directory, set up an empty project and download all the necessary dependencies.
NOTE: By default it will use the core.io project starter. You can create and install your custom project templates. Read more in the documentation.
3. Run project
Last step is to run your project, which could be as simple as opening a terminal window and typing the following command:
$ npm start
You should see the banner ASCII art followed by the logger output in your terminal.
What to do next?
As it stands, our application doesn't do much, and that is by design. Out of the box it provides basic functionality like logging, module and command management, and an interactive REPL.
The next step will be to learn about the [project layout][#project-layout]
To learn more about core.io follow the links:
<!-- LINKS -->