KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #codex #ai-agents #claude-code #dsh #dsh-plugin #cli #macos #ai-agent #deepseek-harness #open-source

adonisjs-hackathon-starter

★ 153 Open GitHub ↗

A boilerplate for AdonisJS web framework

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**Live Demo**: http://adonisjs-hackathonstarter.herokuapp.com/

A boilerplate for **AdonisJS 4.1** web applications.

If you have attended any hackathons in the past, then you know how much time it takes to
get a project started: decide on what to build, pick a programming language, pick a web framework,
pick a CSS framework. A while later, you might have an initial project up on GitHub and only then
can other team members start contributing. Or how about doing something as simple as *Sign in with Facebook*
authentication? You can spend hours on it if you are not familiar with how OAuth 2.0 works.

When I started this project using *AdonisJs*, my primary focus was on **simplicity** and **ease of use** and also integrate as many API as Possible.
I also tried to make it as **generic** and **reusable** as possible to cover most use cases of hackathon web apps,
without being too specific. In the worst case you can use this as a learning guide for your projects,
if for example you are only interested in **Sign in with Google** authentication and nothing else.

AdonisJS Hackathon Starter is a boilerplate application developed with AdonisJS 4.0 (This Branch) to keep you ahead in hackathons.

AdonisJS is a free, open-source Node.js web framework, created by Aman Virk and intended for the development of web applications following the model–view–controller (MVC) architectural pattern

<h4 align="center">Home Example</h4>

![](https://user-images.githubusercontent.com/3502724/30498074-43154190-9a4d-11e7-9c66-00d58f29f682.png)

<h4 align="center">Login Example</h4>

![](https://user-images.githubusercontent.com/3502724/30498075-432c77f2-9a4d-11e7-9731-78af5f9d7875.png)

<h4 align="center">API Examples</h4>

![](https://user-images.githubusercontent.com/3502724/30498072-42f190f6-9a4d-11e7-8e0a-25086d75c0b2.png)

Table of Contents
-----------------

- [Features](#features)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Obtaining API Keys](#obtaining-api-keys)
- [Project Structure](#project-structure)
- [List of Packages](#list-of-packages)
- [Useful Tools and Resources](#useful-tools-and-resources)
- [Recommended Design Resources](#recommended-design-resources)
- [Recommended Node.js Libraries](#recommended-nodejs-libraries)
- [Pro Tips](#pro-tips)
- [FAQ](#faq)
- [How It Works](#how-it-works-mini-guides)
- [Deployment](#deployment)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [License](#license)

Features
--------

- **Local Authentication** using Email and Password
- **OAuth 1.0a Authentication** via Twitter
- **OAuth 2.0 Authentication** via Facebook, Google, GitHub, LinkedIn, Instagram, Foursquare, Bitbucket
- Flash notifications
- MVC Project Structure
- Bootstrap 4
- Contact Form (powered by Mailgun or Mandrill or Sendgrid)
- **Account Management**
	- Gravatar
 	- Profile Details
 	- Change Password
 	- Forgot Password
 	- Reset Password
 	- Delete Account
 	- CSRF protection
 	- Link to Social Accounts
 	- **API Examples**: Facebook, Foursquare, Last.fm, Instagram, Tumblr, Twitter, Stripe, LinkedIn, Google Map, Github e.t.c.

Prerequisites
-------------
- [Mysql](http://www.mysql.com) or [Postgresql](http://www.postgresql.org/)
- [NodeJS 8.0.0+](https://nodejs.org/en/)
- [NPM 4.0.0+](https://www.npmjs.com/)
- [AdonisJS 4.1](http://adonisjs.com/)
- Command Line Tools
    - <img src="http://deluge-torrent.org/images/apple-logo.gif" height="17">&nbsp;**Mac OS X:** [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) (or **OS X 10.9+**: `xcode-select --install`)
    - <img src="http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg" height="17">&nbsp;**Windows:** [Visual Studio](https://www.visualstudio.com/products/visual-studio-community-vs)
    - <img src="https://lh5.googleusercontent.com/-2YS1ceHWyys/AAAAAAAAAAI/AAAAAAAAAAc/0LCb_tsTvmU/s46-c-k/photo.jpg" height="17">&nbsp;**Ubuntu** / <img src="https://upload.wikimedia.org/wikipedia/commons/3/3f/Logo_Linux_Mint.png" height="17">&nbsp;**Linux Mint:** `sudo apt-get install build-essential`
    - <img src="http://i1-news.softpedia-static.com/images/extra/LINUX/small/slw218news1.png" height="17">&nbsp;**Fedora**: `sudo dnf groupinstall "Development Tools"`
    - <img src="https://en.opensuse.org/images/b/be/Logo-geeko_head.png" height="17">&nbsp;**OpenSUSE:** `sudo zypper install --type pattern devel_basis` 	
   
**Note:** If you are new to AdonisJS, I recommend to watch
[Getting Started With AdonisJs](https://www.youtube.com/playlist?list=PLWmIA5YpCsizOMoM3tH5NSp1sHmdzVLvW) screencast by tutlage that teaches AdonisJS 3.2 from scratch. Alternatively,
here is another great tutorial for building a project management app for beginners/intermediate developers by Ayeni Olusegun - [Build A Contact Management web Application with AdonisJS Framework](http://goodheads.io/2017/08/04/build-contact-management-web-application-adonisjs-framework-part-1/) . Since this branch is written with AdonisJS v4.1, Please follow [Upgrade Note](http://adonisjs.com/docs/4.1/upgrade-guide) and follow [Upgrade Note](http://adonisjs.com/docs/4.0/upgrade-guide) for v4.0

Getting Started
---------------

#### Via Cloning The Repository:

```bash

# if you don't have nodemon
npm install -g nodemon

# if you don't have AdonisJS CLI
npm i -g @adonisjs/cli

# To make use of this blueprint
adonis new starter --blueprint=iamraphson/adonisjs-hackathon-starter

# Change directory
cd starter

# Run your migrations
adonis migration:run

adonis serve --dev
```

Obtaining API Keys
------------------

To use any of the included APIs or OAuth authentication methods, you will need
to obtain appropriate credentials: Client ID, Client Secret, API Key, or
Username & Password. You will need to go through each provider to generate new
credentials.

- Visit [Google Cloud Console](https://cloud.google.com/console/project)
- Click on the **Create Project** button
- Enter *Project Name*, then click on **Create** button
- Then click on *APIs & auth* in the sidebar and select *API* tab
- Click on **Google+ API** under *Social APIs*, then click **Enable API**
- Next, under *APIs & auth* in the sidebar click on *Credentials* tab
- Click on **Create new Client ID** button
- Select *Web Application* and click on **Configure Consent Screen**
- Fill out the required fields then click on **Save**
- In the *Create Client ID* modal dialog:
 - **Application Type**: Web Application
 - **Authorized Javascript origins**: http://localhost:3333
 - **Authorized redirect URI**: http://localhost:3333/auth/google/callback
- Click on **Create Client ID** button
- Copy and paste *Client ID* and *Client secret* keys into `.env`

<hr>

- Visit [Facebook Developers](https://developers.facebook.com/)
- Click **My Apps**, then select **Add a New App* from the dropdown menu
- Select **Website** platform and enter a new name for your app
- Click on the **Create New Facebook App ID** button
- Choose a **Category** that best describes your app
- Click on **Create App ID** button
- In the upper right corner click on **Skip Quick Star**
- Copy and paste *App ID* and *App Secret* keys into `.env`
 - **Note:** *App ID* is **clientID**, *App Secret* is **clientSecret**
- Click on the *Settings* tab in the left nav, then click on **+ Add Platform**
- Select **Website**
- Enter `http://localhost:3333` under *Site URL*

**Note:** After a successful sign in with Facebook, a user will be redirected back to home page with appended hash `#_=_` in the URL. It is *not* a bug. See this [Stack Overflow](https://stackoverflow.com/questions/7131909/facebook-callback-appends-to-return-url) discussion for ways to handle it.

<hr>

- Go to [Account Settings](https://github.com/settings/profile)
- Select **Applications** from the sidebar
- Then inside **Developer applications** click on **Register new application**
- Enter *Application Name* and *Homepage URL*
- For *Authorization Callback URL*: http://localhost:3333/auth/github/callback
- Click **Register application**
- Now copy and paste *Client ID* and *Client Secret* keys into `.env` file

<hr>

- Sign in at [https://apps.twitter.com/](https://apps.twitter.com/)
- Click **Create a new application**
- Enter your application name, website and description
- For **Callback URL**: http://127.0.0.1:3333/auth/twitter/callback
- Go to **Settings** tab
- Under *Application Type* select **Read and Write** access
- Check the box **Allow this application to be used to Sign in with Twitter**
- Click **Update this Twitter's applications settings**
- Copy and paste *Consumer Key* and *Consumer Secret* keys into `.env` file

<hr>

- Sign in at [LinkedIn Developer Network](https://developer.linkedin.com/)
- From the account name dropdown menu select **API Keys**
 - *It may ask you to sign in once again*
- Click **+ Add New Application** button
- Fill out all the *required* fields
 - **OAuth 2.0 Redirect URLs**: http://localhost:3333/auth/linkedin/callback
 - **JavaScript API Domains**: http://localhost:3333
- For **Default Application Permissions** make sure at least the following is checked: `r_basicprofile`
- Finish by clicking **Add Application** button
- Copy and paste *API Key* and *Secret Key* keys into `.env` file
 - *API Key* is your **clientID**
 - *Secret Key* is your **clientSecret**

<hr>

- Visit the **Account** section of your Venmo profile after logging in
- Click on the **Developers** tab
- Then click on the [new](https://venmo.com/account/app/new) link next to **Your Applications (0)**
- Fill in the required fields: *App Name* and *What Will The App Be Used For?*
- For **Web Redirect URL** enter: http://localhost:3333/auth/venmo/callback
- Hit **Create** button
- Back on the **Developers** tab click on **view** link next to **Your Applications (1) new**
- Copy and paste **ID** and **Secret** keys into `.env` file

<hr>

- [Sign up](https://stripe.com/) or log into your [dashboard](https://manage.stripe.com)
- Click on your profile and click on Account Settings
- Then click on [API Keys](https://manage.stripe.com/account/apikeys)
- Copy the **Secret Key**. and add this into `.env` file
<hr>

- Visit [PayPal Developer](https://developer.paypal.com/)
- Log in to your PayPal account
- Click **Applications > Create App** in the navigation bar
- Enter *Application Name*, then click **Create app**
- Copy and paste *Client ID* and *Secret* keys into `.env` file
- *App ID* is **client_id**, *App Secret* is **client_secret**
- Change **host** to api.paypal.com if you want to test against production and use the live credentials

<hr>

- Go to [foursquare for Developers](https://developer.foursquare.com/)
- Click on **My Apps** in the top menu
- Click the **Create A New App** button
- Enter *App Name*, *Welcome page url*,
- For **Redirect URI**: http://localhost:3333/auth/foursquare/callback
- Click **Save Changes**
- Copy and paste *Client ID* and *Client Secret* keys into `.env` file

<hr>

- Go to http://www.tumblr.com/oauth/apps
- Once signed in, click **+Register application**
- Fill in all the details
- For **Default Callback URL**: http://localhost:3333/auth/tumblr/callback
- Click **✔Register**
- Copy and paste *OAuth consumer key* and *OAuth consumer secret* keys into `.env` file

<hr>

- Go to https://sendgrid.com/user/signup
- Sign up and **confirm** your account via the *activation email*
- Then enter your SendGrid *Username* and *Password* into `.env` file

<hr>

- Go to http://www.mailgun.com
- Sign up and add your *Domain Name*
- From the domain overview, copy and paste the default SMTP *Login* and *Password* into `.env` file

<hr>

- Go to https://www.twilio.com/try-twilio
- Sign up for an account.
- Once logged into the dashboard, expand the link 'show api credentials'
- Copy your Account Sid and Auth Token

Project Structure
-----------------

| Name                               | Description                                                  |
| ---------------------------------- | ------------------------------------------------------------ |
| **app/Models**/User.js                 | Mysql/Postgresql schema and model for User.                          |
| **app/Models**/UserProfile.js                 | Mysql/Postgresql schema and model for User Profile.                          |
| **app/Controllers/Http**/AccountController.js                 | Controller for Account management                          |
| **app/Controllers/Http**/ClockworkController.js                 | Controller for Clockwork API functionality                           |
| **app/Controllers/Http**/FacebookController.js                 | Controller for Facebook API functionality                            |
| **app/Controllers/Http**/ContactController.js                 | Controller for Contact page                            |
| **app/Controllers/Http**/FoursquareController.js                 | Controller for Foursquare API functionality                           |
| **app/Controllers/Https**/GithubController1.js                 | Controller for Github API functionality                           |
| **app/Controllers/Http**/GoogleMapsController.js                 | Controller for Google Maps API functionality                           |
| **app/Controllers/Http**/HomeController.js                 | Controller for Home Page                           |
| **app/Controllers/Http**/InstagramController.js                 | Controller for Instagram API functionality                           |
| **app/Controllers/Http**/LastFmController.js                 | Controller for LastFM API functionality                           |
| **app/Controllers/Http**/LinkedinController.js                 | Controller for Linkedin API functionality                           |
| **app/Controllers/Http**/LobController.js                 | Controller for Lob API functionality                           |
| **app/Controllers/Http**/NewYorkTimesController.js                 | Controller for New York Times API functionality                  |
| **app/Controllers/Http**/PayPal.js                 | Controller for Paypal API functionality               |
| **app/Controllers/Http**/ScrapingController.js                 | Controller for Web Scraping API functionality              |
| **app/Controllers/Http**/SlackController.js                 | Controller for Slack API functionality              |
| **app/Controllers/Http**/StripeController.js                 | Controller for Stripe API functionality                |
| **app/Controllers/Http**/TumbirController.js                 | Controller for Tumblr API functionality                |
| **app/Controllers/Http**/TwitterController.js                 | Controller for Twitter API functionality                |
| **app/Controllers/Http**/UploadController.js                 | Controller for Upload functionality               |
| **app/Controllers/Http**/YahooController.js                 | Controller for Yahoo functionality               |
| **app/Controllers/Http/Auth**/AuthController.js                 | Controller for login and signup functionality               |
| **app/Controllers/Http/Auth**/PasswordController.js                 | Controller for password reset functionality               |
| **public**/                        | Static assets (fonts, css, js, img).                         |
| **Config**/                        | configurations for your application.                         |
| **database**/                        | All database related files like migration and seed files.                          |
| **public**/style.css       | Main stylesheet for your app.                                |
| **resources/views/account**/                 | Template for *account*.      |
| **resources/views/auth**/                 | Templates for *login, password reset, signup, profile*.      |
| **resources/views/api**/                     | Templates for API Examples.                                  |
| **resources/views/contact**/                     | Template for *Contact*                                 |
| **resources/views/mail**/                     | Templates for *Mail*                                 |
| **resources/views/layout**/alerts.edge                    | Template for error, info and success flash notifications.                               |
| **resources/views/layout**/master.edge                    | Base template.                               |
| **resources/views**/welcome.edge                    | Home page template.                                |
| **resources/views**/api.edge                    | API dashboard template.                               |
| .env.example                       | Your API keys, tokens, passwords and database URI.           |
| server.js                             | The main application file.                                   |
| package.json                       | NPM dependencies.                                            |
| package-lock.lock                          | Contains exact versions of NPM dependencies in package.json. |
| ace                         | File for enabling commands to run     |

List of Packages
----------------

| Package                         | Description                                                           |
| ------------------------------- | --------------------------------------------------------------------- |
| adonis-ally                           | AdonisJs social authentication provider              |
| @slack/client                           | Slack Package              |
| async                           | Utility library that provides asynchronous control flow.              |
| bcrypt-nodejs                   | Library for hashing and salting user passwords.                       |
| cheerio                         | Scrape web pages using jQuery-style syntax.                           |
| clockwork                       | Clockwork SMS API library.                                            |
| mysql                            | MySql ODM                                  |
| pg                            | Postgresql ODM                                  |
| dotenv                          | Loads environment variables from .env file.                           |
| @adonisjs/framework                | Node.js web framework.                                                |
| cloudinary                        | Upload images/videos to Cloudinary                                             |
| serve-favicon                   | Express 4 middleware offering favicon serving and caching.            |
| fbgraph                         | Facebook Graph API library.                                           |
| @octokit/rest                   | GitHub API library.                                                   |
| lastfm                          | Last.fm API library.                                                  |
| instagram-node                  | Instagram API library.                                                |
| lob                             | Lob API library                                                       |
| node-foursquare                 | Foursquare API library.                                               |
| node-linkedin                   | LinkedIn API library.                                                 |
| Instagram                       | Instagram API library.                                                 |
| Moment                           | Date / Time Library.                                        |
| nodemailer                      | Node.js library for sending emails.                                   |
| paypal-rest-sdk                 | PayPal APIs library.                                                  |
| request                         | Simplified HTTP request library.                                      |
| stripe                          | Offical Stripe API library.                                           |
| tumblr.js                       | Tumblr API library.                                                   |
| twilio                          | Twilio API library.                                                   |
| twit                            | Twitter API library.                                                  |
| lodash                          | Handy JavaScript utlities library.                                    |
| @adonisjs/validator       | Validate form in adonisJS |
| @adonisjs/auth            | Authentication provider in AdonisJS  |
| @adonisjs/lucid            | ORM provider in AdonisJS  |
| @adonisjs/mail            | Mail provider in AdonisJS  |
| @adonisjs/session            | Session provider in AdonisJS  |
| mocha                           | Test framework.                                                       |
|standard                       | JavaScript Standard Style            |

Useful Tools and Resources
--------------------------
- [JavaScripting](http://www.javascripting.com/) - The Database of JavaScript Libraries
- [JS Recipes](http://sahatyalkabov.com/jsrecipes/) - JavaScript tutorials for backend and frontend development.
- [Jade Syntax Documentation by Example](http://naltatis.github.io/jade-syntax-docs/#attributes) - Even better than official Jade docs.
- [HTML to Jade converter](http://html2jade.aaron-powell.com) - Extremely valuable when you need to quickly copy and paste HTML snippets from the web.
- [JavascriptOO](http://www.javascriptoo.com/) - A directory of JavaScript libraries with examples, CDN links, statistics, and videos.
- [Favicon Generator](http://realfavicongenerator.net/) - Generate favicons for PC, Android, iOS, Windows 8.
- [Goodheads](http://goodheads.io) - Laravel, PHP, Node.js and JS tutorials
- [Favicon Generator](http://realfavicongenerator.net/) - Generate favicons for PC, Android, iOS, Windows 8.
-

Recommended Design Resources
----------------------------
- [Code Guide](http://codeguide.co/) - Standards for developing flexible, durable, and sustainable HTML and CSS.
- [Bootsnipp](http://bootsnipp.com/) - Code snippets for Bootstrap.
- [UIBox](http://www.uibox.in) - Curated HTML, CSS, JS, UI components.
- [Bootstrap Zero](https://www.bootstrapzero.com) - Free Bootstrap templates themes.
- [Google Bootstrap](http://todc.github.io/todc-bootstrap/) - Google-styled theme for Bootstrap.
- [Font Awesome Icons](http://fortawesome.github.io/Font-Awesome/icons/) - It's already part of the Hackathon Starter, so use this page as a reference.
- [Colors](http://clrs.cc) - A nicer color palette for the web.
- [Creative Button Styles](http://tympanus.net/Development/CreativeButtons/) - awesome button styles.
- [Creative Link Effects](http://tympanus.net/Development/CreativeLinkEffects/) - Beautiful link effects in CSS.
- [Medium Scroll Effect](http://codepen.io/andreasstorm/pen/pyjEh) - Fade in/out header background image as you scroll.
- [GeoPattern](https://github.com/btmills/geopattern) - SVG background pattern generator.
- [Trianglify](https://github.com/qrohlf/trianglify) - SVG low-poly background pattern generator.

Recommended Node.js Libraries
-----------------------------

- [Nodemon](https://github.com/remy/nodemon) - Automatically restart Node.js server on code changes.
- [geoip-lite](https://github.com/bluesmoon/node-geoip) - Geolocation coordinates from IP address.
- [Filesize.js](http://filesizejs.com/) - Pretty file sizes, e.g. `filesize(265318); // "265.32 kB"`.
- [Numeral.js](http://numeraljs.com) - Library for formatting and manipulating numbers.
- [Node Inspector](https://github.com/node-inspector/node-inspector) - Node.js debugger based on Chrome Developer Tools.
- [node-taglib](https://github.com/nikhilm/node-taglib) - Library for reading the meta-data of several popular audio formats.
- [sharp](https://github.com/lovell/sharp) - Node.js module for resizing JPEG, PNG, WebP and TIFF images.

FAQ
---

### Why do I get `csrf token mismatch` when submitting a form?
You need to add the following code to your form. This has been
added in the existing codebase as part of the CSRF protection.

```
{{ csrfField() }}
```
### I get a whoops error when I deploy my app, why?
Chances are you haven't generated the app key, so run `adonis key:generate`.
Chances are you haven't put your credentials in your .env file.

How It Works (mini guides)
--------------------------

This section is intended for giving you a detailed explanation about
how a particular functionality works. Maybe you are just curious about
how it works, or maybe you are lost and confused while reading the code,
I hope it provides some guidance to you.

<hr>

### How do flash messages work in this project?
Flash messages allow you to display a message at the end of the request and access
it on next request and only next request. For instance, on a failed login attempt, you would
display an alert with some error message, but as soon as you refresh that page or visit a different
page and come back to the login page, that error message will be gone. It is only displayed once. All flash messages are available in your views via adonisJS sessions.
To send a flash message to the view, you need to add the following code 
```js
session.flash{error: "Eroor due to 1.2.3 .."})
```
To display the flash message,you need to add the following code.
```twig
@if(old('error'))
    <div class="alert alert-danger">
        {{ old('error') }}
    </div>
@endif
```

<hr>

### How do I create a new page?
A more correct way to be to say "How do I create a new route". The main file `routes.js` contains all the routes. It's located in the **start** directory
Each route has a callback function associated with it. You will see 2 arguments
to routes. In cases like that, the first argument is still a URL string, while the second argument is a callback function.  Example is a route that requires authentication.

```js
const Route = use('Route')
Route::get('/account', 'AccountController.getAccount').middleware('auth')
```
It always goes from left to right. A user visits `/account` page. Then `auth` middleware checks if you are authenticated:

Here is a typical workflow for adding new routes to your application. Let's say we are building a page that lists all books from database.

**Step 1.** Start by defining a route.

```js
const Route = use('Route')
Route::get('/books', 'BookController.getBooks');
```
---

**Step 2.** Create a new model `Book.js` inside the *app/Models* directory. You can simply run `adonis make:model Book`

```js
'use strict'

const Model = use('Model')

class Book extends Model {
  
}

module.exports = Book
```

**Step 3.** Create a migration file like so: `adonis make:migration create_books_table` and it will ask you `choose an action ` select `Create table`

```js
'use strict'

const Schema = use('Schema')

class CreateBooksTableTableSchema extends Schema {

up () {
    this.table('books', (table) => {
    	table.increments()
        table.string('name').nullable()
        table.string('isbn').nullable()
        table.timestamps()
    });
  }

down () {
    this.drop('books');
  }
}

module.exports = CreateBooksTableTableSchema
```

**Step 4.** Create a new controller file called `BookController.js` inside the *app/Controllers/Http* directory. You can simply run `adonis make:controller BookController` and it will ask you `Generating a controller for ?` select `Http Request`

```js
'use strict'

const Book = use('App/Models/Book')

class BookController {

/**
     * Return all books
     * @return View
     */
  async getBooks({view}) {
    let books = await Book.all();

return view.render('books', { books: books.toJSON() })
  }
  
}

module.exports = BookController
```

**Step 5.** Create `books.edge` template in *resources/views* directory

```js
@layout('layout.master')

@section('content')
    @include('layout.nav')
    <div class="main-container">
        @include('layout.alerts')

<div class="page-header">
            <h2><i style="color: #f00" class="fa fa-book"></i>All Books</h2>
        </div>

<ul>
        @each(book in books)
            <li> {{ book.name }} </li>
        @endeach
        </div>
    </div>
@endsection
```

That's it!
<hr>

Deployment
----------

Once you are ready to deploy your app, you will need to create an account with a cloud platform to host it. These are not the only choices, but they are my top
picks. From my experience, **Heroku** is the easiest to get started with,  deployments and custom domain support on free accounts.

### 1-Step Deployment with Heroku

- Download and install [Heroku Toolbelt](https://toolbelt.heroku.com/)
- In terminal, run `heroku login` and enter your Heroku credentials
- From *your app* directory run `heroku create`
- Create a Procfile in your app root. All this file needs to contain is `web: ENV_SILENT=true node server.js` 
- Run `heroku addons:add heroku-postgresql:dev  ` to add a Postgres database to your heroku app from your terminal
- Since AdonisJS v4 uses Node version 8 or greater and NPM version 3 or greater, we need to state which Node and NPM engine in package.JSON by adding this to the JSON
```JSON
 "engines": {
    "node": "8.1.x",
    "npm": "5.4.X"
  }
```
- Lastly, do `git push heroku master`.  Done!
- Run artisan commands on heroku like so `heroku run node ace migration:run`

**Note:** To install Heroku add-ons your account must be verified.

---
<img src="http://www.opencloudconf.com/images/openshift_logo.png" width="200">

- First, install this Ruby gem: `sudo gem install rhc` :gem:
- Run `rhc login` and enter your OpenShift credentials
- From your app directory run `rhc app create MyApp nodejs-0.10`
 - **Note:** *MyApp* is the name of your app (no spaces)
- Once that is done, you will be provided with **URL**, **SSH** and **Git Remote** links
- Visit provided **URL** and you should see the *Welcome to your Node.js application on OpenShift* page
- Copy and and paste **Git Remote** into `git remote add openshift YOUR_GIT_REMOTE`
- Before you push your app, you need to do a few modifications to your code

go to `htpp.js` in *bootstrap* directory,

Then change `Server.listen(Env.get('HOST'), Env.get('PORT'))` to:
```js
Server.listen(Env.get('OPENSHIFT_NODEJS_IP') || '127.0.0.1', Env.get('OPENSHIFT_NODEJS_PORT') || 3333)
```
Add this to `package.json`, after *name* and *version*. This is necessary because, by default, OpenShift looks for `server.js` file. And by specifying `ENV_SILENT=true supervisor server.js` it will automatically restart the server when node.js process crashes.

```js
"main": "server.js",
"scripts": {
  "start": "ENV_SILENT=true supervisor server.js"
},
```

- Finally, you can now push your code to OpenShift by running `git push -f openshift master`
 - **Note:** The first time you run this command, you have to pass `-f` (force) flag because OpenShift creates a dummy server with the welcome page when you create a new Node.js app. Passing `-f` flag will override everything with your *Hackathon Starter* project repository. **Do not** run `git pull` as it will create unnecessary merge conflicts.
- And you are done!

## Contributing

Thank you for considering contributing to AdonisJS Hackathon Starter.

## Security Vulnerabilities

If you discover a security vulnerability within Hackathon Starter, please send an e-mail to Ayeni Olusegun at nsegun5@gmail.com. All security vulnerabilities will be promptly addressed.

## Credits
* [Sahat Yalkabov](https://github.com/sahat/hackathon-starter)

## How can I thank you?

Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!

Don't forget to [follow me on twitter](https://twitter.com/iamraphson)!

Thanks!
Ayeni Olusegun.

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.

adonisjs-hackathon-starter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README