Giter VIP home page Giter VIP logo

codex's Introduction

Codex: A Simple Single-User Reference Web Application

Codex

Codex is a simple single-user reference web application written in Ruby. Codex uses Sinatra and Datamapper to create, save, update, and delete page records from a simple Postgres database. The application is ready for immediate deployment on Heroku.

Markdown formatting is enabled for all pages, which makes it easy to write complex pages with simple markup. HTTP authentication and forced SSL for all traffic keeps your information secure. Bootstrap styling and Subtle Patterns backgrounds make your pages look clean and attractive.

History

I developed Codex for two reasons:

  1. It's useful. If you need a simple reference database for business or personal use, Codex is a good fit. It's simple, free, and inexpensive to maintain. (At present, Heroku's basic plan is free and has more than enough power to run Codex.)
  2. It's educational. The code at the heart of Codex contains all of the major concepts in CRUD-style application development: connecting to the database, creating records, updating records, and deleting records. It's also a good illustration of various data types, conditionals, helpers, and methods.

Codex is one of my first exercises in Ruby web application development. Developing Codex was my first introduction to good version control practices, Datamapper, Basic HTTP-Authentication, SSL, and deploying database-driven applications on Heroku.

Deploy Codex to Heroku

Clone the codex repo:

$ git clone [email protected]:eurekaoverdrive/codex.git

Add all files to a new Git repo:

$ git init .

$ git add -A

$ git commit -m "Initial commit"

Create a new Heroku application:

$ heroku create yourappname

Add the shared-database addon to your application:

$ heroku addons:add shared-database    

Add environment variables for your username and password:

$ heroku config:add ADMIN_USER=username

$ heroku config:add ADMIN_PASS=t0psecret

Push the master Git branch to Heroku:

$ git push heroku master

Run the setup command in rake:

$ heroku rake setup

Open your new Codex:

$ heroku open

Enjoy!

codex's People

Contributors

worldlywisdom avatar

Watchers

 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.