rak3rman / auth-webframework-nodejs

Auth WebFramework NodeJS - A general template for a NodeJS web application running express with authentication

Auth WebFramework NodeJS

A general template for a nodejs web application running express with authentication

Basic Structure

This project is a auth web framework which uses the plugin Passport.js to provide authentication for the webpage routes. Being a 'auth' framework, this project is very minimal and only displays a webpage through a specified port with authentication. The structure of this application is described below in the application map.

Application Map

--app.js # Primary NodeJS file
--routes # Routes for views
  --authRoutes.js
  --mainRoutes.js
--views # Components of webpage, HTML
  --pages
    --home.ejs # Home Page
    --error.ejs # Error Page
    --login.ejs # Login Page
    --sign_up.ejs # Sign Up Page
--config # Folder where configurations are set
  --exitOpt.js # Exit options when running in testing environment
  --sysConfig.json # Appears upon system configuration within application
--resolvers # Logic Resolvers
  --authResolver # Auth Logic
--models # MongoDB Model's
  --userModel.js # MongoDB Auth Model
--sys_funct # System Functions
  --passport.js # Passport.js Logic
--static # Place static files to be accessed by webpage here
--package.json # NPM 
--package-lock.json
--start.sh
--LICENSE
--README.md
--.travis.yml
--.gitignore

Install and Setup

• Clone the repository from github.com

git clone https://github.com/RAK3RMAN/auth-webframework-nodejs.git

• Setup Base WebFramework NodeJS
  • Enter the auth-webframework-nodejs folder
    • cd auth-webframework-nodejs
  • Install all required packages with root-level access (if needed)
    • sudo npm install
  • Start default application using npm
    • npm start
  • If you want a different broadcast port or mongodb url, you can configure these values by proceeding with the:
    • Hardcode option:
      • Enter the sysConfig.json file
        • sudo nano auth-webframework-nodejs/config/sysConfig.json
      • Edit the console_port or mongodb_url parameters to your desired configuration
  • If any errors occur, please read the logs and attempt to resolve. If resolution cannot be achieved, post in the issues under this project.
• Access web application through localhost:3000 to ensure application is active
• Change mongodb_url if needed (steps given above)
• Navigate to the signup page localhost:3000/signup and enter username and password
• You should then be directed to the secret dashboard page, the signup was unsuccessful if you were redirected back to the signup page
• By clicking the logout button or directing to localhost:3000/logout, you can remove your credentials from the session
• Then you can login regularly through the login page at localhost:3000/login