Skip to content

Releases: noremacsim/DriftyJS

v1.0.0

29 Nov 19:52
972fafb
Compare
Choose a tag to compare
v1.0.0 Pre-release
Pre-release

DriftyJS FrameWork

DriftyJS is a NodeJS Framework Built with a MVC design and ORM Support
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Project Structure
  4. Usage
  5. Contributing
  6. License

About The Project

DriftyJS is a framework to easily, securly and quickly launch a enterprise scale application with Database, Models, Controlers and View support with already API and sophisticated routers.
It was made to easily create any application following a MVC design, The DriftyJS Framework isnt a skeleton it has the core features of:

  • User Authentication
  • Two-Factor Authentication
  • ORM Support
  • Controllers
  • Models
  • Views
  • Middleware
  • API
  • JWT Tokens
  • Many More...

Here's why:

  • Your time should be focused on building a scalable and secure application not the architecture
  • You shouldn't be writing the same stuff over and over again
  • Easier transiction from PHP

Built With

DriftyJS is Build with:

Getting Started

Prerequisites

  • nodejs
  • database

Installation

  1. Clone the repo
    git clone https://github.com/noremacsim/DriftyJS.git
  2. Install NPM packages
    npm install
  3. Please rename .env.example to .env in Project Root
  4. Update .env variables with your setup
  5. Start The Application
    ./bin/drifty-serve.js

DB Support

  • mariadb
  • mysql
  • mongoose

Project Structure

Inside App is where your project will live, this is where you can create your controllers, define models, edit styles or import, add migrations, plugins define your routes. Build the whole application within here.

├───App
│   ├───assets
│   │   ├───css
│   │   ├───fonts
│   │   ├───img
│   │   ├───js
│   │   └───scss
│   ├───config
│   ├───controllers
│   ├───helpers
│   ├───middleware
│   ├───migrations
│   ├───models
│   ├───plugins
│   ├───routes
│   ├───Storage
│   └───views

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Websites Using Drifty

cameronsim My Personal Website.

v0.5.1 - First Release

22 Nov 20:37
497fef1
Compare
Choose a tag to compare
Pre-release

What DriftyJS Acheives

Good architecture build of a fully fledged hosted nodejs app, with ORM support.
Our structure follows all good MVC design you would have seen else where and utalising the best plugins of hapi, ejs and seqalize
we can preload all our plugins/modules on server start. allow fast and scalable nodejs applications
to be built

  • app
    • //Everything here is where you'll put your app.
      • assets
      • controllers
      • helpers
      • middleware
      • migrations
      • models
      • plugins
      • routes
      • views
  • bin
    • // This are core scripts to start the nodejs
    • // Or run the migrations
  • Core
    • // This is where all the magic happens to make this application work

Featutes

This framework has a number of feature's setup and can be used out of the box

  • Two-Factor Authentication
  • User Signin/Signup
  • Usr Groups multiple users can be part of a group
  • User Company's multiple groups can be part of a company
  • Messages we can implement instant messaging and messaging groups
  • Friends, Followers users can add/remove/accept and follow other users
  • Posts a user can create a post and retrieve their following posts
  • Calendar a calendar can have a number of events that can be associated with a company/user or a group
  • Fully intigrated API and authentication
  • Fully intigratied View Authentication for Front End

Most of these features are from the API and need a Frontend Built but the work is there.

What's Changed

Full Changelog: https://github.com/noremacsim/DriftyJS/commits/v0.5