https://github.com/futurestudio/hapi-rethinkdb-dash
NOT MAINTAINED. Account boilerplate based on hapi and RethinkDB
https://github.com/futurestudio/hapi-rethinkdb-dash
boilerplate hapi nodejs rethinkdb thinky
Last synced: 8 months ago
JSON representation
NOT MAINTAINED. Account boilerplate based on hapi and RethinkDB
- Host: GitHub
- URL: https://github.com/futurestudio/hapi-rethinkdb-dash
- Owner: futurestudio
- License: mit
- Created: 2015-03-30T13:39:19.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-01-22T22:00:08.000Z (about 7 years ago)
- Last Synced: 2025-04-12T19:08:50.914Z (10 months ago)
- Topics: boilerplate, hapi, nodejs, rethinkdb, thinky
- Language: JavaScript
- Homepage: https://futurestud.io/
- Size: 134 KB
- Stars: 31
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
hapi RethinkDB Dash
==========================
Your Node.js boilerplate based on [hapi](http://hapijs.com/) and [RethinkDB](https://rethinkdb.com/).
[](https://semaphoreci.com/futurestudio/hapi-rethinkdb-dash)
[](https://snyk.io/test/github/fs-opensource/hapi-rethinkdb-dash)
## Futureflix
`hapi-rethinkdb-dash` is outdated and currently unmaintained. You can still benefit from the ideas within this code.
We started **[learn hapi](http://learnhapi.com) as a learning path for the hapi web framework**. Become a hapi hero by following the tutorial series.
You’ll build a complete app from start to finish. From zero to hero!
Check out the [Futureflix Starter Kit](https://github.com/fs-opensource/futureflix-starter-kit) for more details :tv:
-----
## Project Overview
This is a project boilerplate based on Node.js and RethinkDB. It reduces the initial effort which comes for every project. You can start with the fun things and skip the implementation of an account system (for the 25th time).
Development of Hapi-RethinkDB-Dash is ongoing and we plan to implement new features over time. The following list depicts the already available features
- Accounts
- Create new Accounts (Email/Password)
- Login
- Edit account information (Name, Homepage)
- Change Password
- Delete Account
- Environment-based database access
- different DBs for development, testing and production environments (per NODE_ENV)
- Test Coverage
## Stack
Hapi-RethinkDB-Dash requires
- Node.js
- RethinkDB
Besides the core technologies it uses the following components (this list is very likely incomplete):
- [hapi](https://hapijs.com/) — Node.js web framework
- [RethinkDB](https://rethinkdb.com/) — Open-Source database for the realtime web
- [Handlebars](http://handlebarsjs.com/) — HTML templating engine
- [bcrypt](https://www.npmjs.com/package/bcrypt) — For password encryption
- [Twitter Bootstrap v3](http://getbootstrap.com/) — UI component & layout library
- [Lab](https://github.com/hapijs/lab) — Node.js testing framework
## Configuration & Install
Install Node.js and RethinkDB before usage.
```bash
git clone git@github.com:fs-opensource/hapi-rethinkdb-dash.git
cd hapi-rethinkdb-dash
npm install
```
The **database configuration** is placed in `server/config/database.js`.
```bash
nano server/config/database.js
```
Currently this project does not use any handlebars helpers. That's why git deletes the `helpers` folder from within the `views` folder. Enabling helper classes requires you to uncomment the respective line in `server/config/settings.js`.
The password reset functionality requires a valid mail configuration. Change the `email` and `baseUrl` settings to make things work.
```bash
nano server/config/settings.js
```
Start server
```bash
node server
```
Everything went smooth? Visit
```bash
localhost:3000
```
## Tests
Run tests with
```bash
npm test
```
## Contributions
We very warmly welcome any contributions. If it's bugs, feature requests or implementation, we enjoy feedback :)
The MIT License (MIT)
Copyright (c) 2015 Future Studio
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.