Skip to content
Mathias Quintero edited this page Mar 28, 2016 · 6 revisions

Getting Started

Hello! This is Aeolus. The instant REST API by Atomic Llama.

We're always working to improve this new Framework of ours. And now we want to give you a brief showcase of what you can do with it!

One of the key features of the framework is that it allows you to host a website and your REST API on the same server with the minimal amount of code.

Installing Aeolus

Aeolus works with node and you can use it to start from scratch or compliment your current project.

Starting From Scratch

To create a new project with Aeolus you will need Node and npm installed http://nodejs.org and https://www.npmjs.com

Once done with that. You can install Aeolus from the terminal.

$ npm install aeolus -g

To create your project you can navigate to the folder where you want it (or create one) and run our wizard with

$ aeolus

Simply follow the steps and you will have a whole project already in front of you!

Add Aeolus to your current project

Perhaps you already know a bit about Node and don't need our wizard.

Simply run:

$ npm install aeolus --save

And our Framework will be already installed for you to use.

Clone this wiki locally