Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.61 KB

README.md

File metadata and controls

47 lines (33 loc) · 2.61 KB
Raw

This is Perspex, a Web application for retrieving data from the Elasticsearch server containing the HonSSH data.

The structure of the application is based on the excellent Starterpack.js (http://starterpackjs.com); some sections of the original framework were not germane to Perspex -- for example, maintaining users' first and last names, or the ability to log in using Facebook credentials -- and those parts have been removed. In addition, the database code has been modified to use sqlite instead of MySQL.

Below is the original README.md from Starterpack.js:

Alt Starterpack.js

Simple Node.js Authentication. Write less boilerplate.

You can see the site live at Starterpack.js

All you need to get started is this framework and an idea. With the simplicity of Node.js, the awesomeness of SQL and authentication courtesy of Passport.js you don't have to bother with boilerplate.

##Stack##

  • Node.js
  • Express.js
  • Sequelize.js
  • Passport.js
  • Bootstrap
  • Jade
  • Coffeescript

###Login### Alt

###Home### Alt

###User Update### Alt

The purpose behind this project is to decrease the amount of boilerplate code that needs to be written in order to get an app or website off the ground. I really wanted to like noSQL databases but I really like the performance and scalability of SQL. I wanted to combine the best frameworks into a single project to be able to focus on more important aspects of projects, not just the setup and boilerplate of writing authentication.

The aim of this project was to write very modular and extensible code in order for others to leverage it as they want. I've included 4 main routes for social authentication: Google+, Facebook, Twitter, and Github and made it fairly easy to add more. There is also an option for local authentication all of which leverage the fantastic Passport.js project.

##Features##

  • Local authentication
  • Social Authentication (Facebook, Twitter, Google, Github)
  • Account CRUD - ability to link/unlink multiple social accounts
  • Authenticated Routes
  • Not having to write account creation/management boilerplate
  • Having an awesome stack and a SQL DB
  • Getting all of this for free