/Huayra

A website and user system starter base on Node and React.

Primary LanguageJavaScriptMIT LicenseMIT

Huayra

Standard - JavaScript Style Guide License: MIT PRs Welcome

Built heavily based on Aqua and Drywall, a website and user system starter base on Node.JS v8.*. Implemented with Express and React.

On The Server On The Client Development
Express Bootstrap react-scripts
Mongoose React Nodemon
Passport Redux concurrently
Async Font-Awesome
EmailJS

img

Features

  • Universal front-end website
    • Basic web pages ready to customize
    • Contact page with form to email
    • Account sign-up page
    • Login pages including forgot and reset password
  • My account area
    • Stub dashboard ready to customize
    • Settings screen to update contact info and login credentials
  • Admin back office
    • Stub dashboard ready to customize
    • Manage users

Technology

Server side, Huayra is built with the Express framework. We're using MongoDB as a data store.

The front-end is built with React. We use Redux as our state container. Client side routing is done with React Router. We're using create-react-app for the build system.

We use bcrypt for hashing secrets. If you have issues during installation related to bcrypt then refer to this page.

Installation

$ npm install

Setup

First you need to setup your config file.

$ mv ./config.example.js ./config.js #set mongodb and email credentials

Set Admin

Register the root account and run command.

$ cd db-scripts
$ mongo S001-init-admin-database.js

Running the app

$ npm start
# [0]
# [0] > huayra@0.18.1 server C:\git\huayra
# [0] > nodemon app.js
# [0]
# [1]
# [1] > huayra@0.18.1 client C:\git\huayra
# [1] > react-scripts start
# [1]
# [0] [nodemon] 1.14.9
# [0] [nodemon] to restart at any time, enter `rs`
# [0] [nodemon] watching: *.*
# [0] [nodemon] starting `node app.js`
# [0] Server is running on port 3001

Build Front-End For Deployment

$ npm run build

Test

$ npm test