@hamistudios/octo

octo

simplistic nodejs web framework

📢 Introduction

Octo is built to make building websites simple and to utilize modern JavaScript standards by using Babel to compile source code to allow the use of ES5 classes within node. Octo uses Express under the hood for fast and reliable request processing. This allows you to use already well developed plugins/integrations with Octo.

We started to develop Octo because we found that making websites was too messy with long index, routes and middleware files. Octo is designed to have simple easy to read files which are specific to one task making it easy to organize and maintain source files.

📡 Installation

$ npm install --save @hamistudios/octo

🚀 Getting started

We have created a simple starter/demo repo with a simple webstie made in Octo, you can clone the repo to get to grips with the framework and also use it as a starting point for your next big project.

To get started clone the repo, install the dependencies and start the dev server.

$ git clone https://github.com/HamiStudios/octo-starter
$ cd octo-starter
$ npm install
$ npm run dev

Once the server is running visit http://localhost:8585

📝 Contributing

We are open to any issues and pull requests submitted under the following rules:

• All issues raised must following the issue guide.
• All pull requests must follow the Airbnb JavaScript style guide.
• All pull requests for new features must be approved via an issue otherwise it will be declined.