Code Monkey home page Code Monkey logo

paddock's Introduction

paddock

Up and Running development environment built with parse-server and docker.

TL;DR

Install Docker and run docker-compose, wait for some magic to happen (requires internet) and check 0.0.0.0:8080.

Spoiler Alert: the demo is at paddock.tech.

Install

To get started with paddock you're only going to need Docker installed:

Start

In order to start the parse-server with Docker open your terminal and run docker-compose:

# Create and start containers (get easy access to the logs)
docker-compose up

# or create and start containers in Detached mode (`-d` runs containers in the background)
docker-compose up -d

This command is going to download two images: alpine-node and alpine-mongo, and it's going to start three Docker containers (Front-end, Back-end and Database).

Node.js containers will start with the $NODE_ENV environment variables set in .env and server/.env.

npm install in Node.js containers will be automatically executed from the prestart scripts. Wait for the installs to finish and you'll be ready to go.

Use the paddock UI

Open http://0.0.0.0:8080/

Use the parse-server API

Excerpt from parse-server

Saving your first object (POST)

curl -X POST \
  -H "X-Parse-Application-Id: APPLICATION_ID" \
  -H "Content-Type: application/json" \
  -d '{"score":1337,"playerName":"Sean Plott","cheatMode":false}' \
  http://localhost:1337/parse/classes/GameScore

Retrieving your collection (GET)

$ curl -X GET \
  -H "X-Parse-Application-Id: APPLICATION_ID" \
  http://localhost:1337/parse/classes/GameScore

Access to MongoDB

Need a GUI? Check Robomongo

Configuration

paddock comes bundled with some of the main features from parse-server. By default we enabled oauth login (with Twitter, so far) in server/config/parse.js. Email verification is optional. Both these features need API keys (if you want to keep them).

Mailgun (email verification)

Getting started with Mailgun is free and takes 57 seconds. http://www.mailgun.com/

(Walkthrough TBD)

Twitter (social login)

Sign in with your Twitter Account to create and maintain Twitter Apps. https://apps.twitter.com/

(Walkthrough TBD)

Features

Email verification

(TBD)

Oauth login (Twitter)

(TBD)

ACL

(TBD)

Cloud code

(TBD)

Deploy

Current deploy strategy is based onto a Dockerfile: Dockerfile.deploy.

Docker Cloud

paddock itself is built and deployed with Docker Cloud, based onto the Dockerfile.deploy configuration.

HYPER_

https://www.hyper.sh/

hyper compose up --file=hyper-deploy.yml -d

(TBD)

now

(TBD) https://now.sh

Demo

You can check the demo at paddock.tech

FAQ

  • Is this production ready?

No

Miscellaneous

Other useful docker-compose commands

# List containers
docker-compose ps
# View output from containers
docker-compose logs
# Stop and remove containers, networks, images, and volumes
docker-compose down
# Build or rebuild services
docker-compose build

paddock's People

Contributors

gesposito avatar rmariuzzo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.