Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wafttech/waftengine

MERN Stack Framework
https://github.com/wafttech/waftengine

javascript mern-project mern-stack mern-stack-engine mongodb mongoose nodejs reactjs starter-project startups

Last synced: about 17 hours ago
JSON representation

MERN Stack Framework

Awesome Lists containing this project

README 

        
# WaftEngine (MERN Stack Engine)



[WaftEngine](https://waftengine.org) 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](https://badges.gitter.im/waftengine/community.svg)](https://gitter.im/waftengine/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FWaftTech%2FWaftEngine.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FWaftTech%2FWaftEngine?ref=badge_shield)



## 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  && cd `

- 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 : `[email protected]` , Password : `Test@1234`

- For more [Getting started](https://waftengine.org/documentation/2019-7-1-getting-started-with-waftengine)



## Get involved



Read documentation & tutorials



- [Developer Documentation](https://waftengine.org/documentation/2019-6-16-introduction-to-waftengine)

- [Architecture](https://waftengine.org/architecture)



## Backers



[Become a backer](https://opencollective.com/waftengine) and show your support to our open source project on [our site](https://waftengine.org).






## 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](https://github.com/WaftTech/WaftEngine#readme) and on [our site](https://waftengine.org/) - who doesn't want a little extra exposure? [Here's the info](https://opencollective.com/waftengine).



## Get help & contact the team



- [WaftEngine Gitter Chat](https://gitter.im/waftengine/community)

- Report security vulnerabilities to .

- [Bug Post and Feature Request](https://github.com/WaftTech/WaftEngine/issues)



## Contribute



:star: Star us on GitHub — it helps!



We love your pull requests! Check out our [`Good First Issue`](https://github.com/WaftTech/WaftEngine/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) and [`Help Wanted`](https://github.com/WaftTech/WaftEngine/issues?q=label%3A%22help+wanted%22) tags for good issues to tackle.



### License



Copyright © [The MIT License (MIT)](./LICENSE.md)



[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FWaftTech%2FWaftEngine.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FWaftTech%2FWaftEngine?ref=badge_large)