Skip to content

WaftTech/WaftEngine

Repository files navigation

WaftEngine (MERN Stack Engine)

WaftEngine is an open source platform for developers to create enterprise level web application in MERN stack. This platform already contains components like user management, roles management, module management, access management, content management with production ready setup which helps developers to develop their application in minimum cost.

Gitter FOSSA Status

Features

WaftEngine core features include:

  • User Manage and Login flow
  • Role Manage
  • Module Manage with Access level Definition
  • Access Management associated with roles
  • Email Template and settings
  • Media Manage and server side processing
  • Error handling and log Management
  • Authentication and Authorization
  • Content Management
  • State Management using redux
  • Development ready setup
  • Production ready setup

Since anything in our codebase can be extended, overwritten, or installed as a package, you may also develop, scale, and customize anything on our platform.

Installation

  • git clone <this_url> && cd <repo_name>
  • install npm on client and server
    • cd client
    • npm install
    • cd ../server
    • npm install
  • Import Default data into MongoDB server from database folder
    • cd ../database
    • run mongorestore to import all BSON/json files
  • Configure Server
    • Create .env file in server
    • Update .env file with MONGODB_URI=mongodb://localhost:27017/waft-engine
  • Configure Client
    • Create .env file in client
    • Update .env file with VITE_API_BASE=http://localhost:5050/api/
  • Running the application in development mode
    • Development Mode (Client only): cd client then npm run start then open http://localhost:5051 in a browser
    • Development Mode (Server only): cd server then npm run start then open http://localhost:5050 in a browser
  • Default Credentials : Email : admin@waftengine.org , Password : Test@1234
  • For more Getting started

Get involved

Read documentation & tutorials

Backers

Become a backer and show your support to our open source project on our site.

Sponsor

Does your company use WaftEngine? Ask your manager or marketing team if your company would be interested in supporting our project. Support will allow the maintainers to dedicate more time for maintenance and new features for everyone. Also, your company's logo will show on GitHub and on our site - who doesn't want a little extra exposure? Here's the info.

Get help & contact the team

Contribute

⭐ Star us on GitHub — it helps!

We love your pull requests! Check out our Good First Issue and Help Wanted tags for good issues to tackle.

License

Copyright © The MIT License (MIT)

FOSSA Status