DotApp

A tiny, light-weight and full-featured nodejs framework built on express.js.

DOTAPP is shipped with combination of open sources libraries which are fully integrated to save the development time like users, roles an media.

Requirements

• nodejs >= 12.0.0
• git
• mongodb

Installation

$ git clone https://github.com/basemkhirat/dotapp-framework blog
$ cd blog
$ npm install

Configuration

1. Rename the file .env.example to .env.

2. Change configurations in .env according to your environment. The .env file appears like this:

   ``` bash
   NODE_ENV=development
   APP_DEBUG=true
   APP_URL=http://localhost:3000
   APP_PORT=3000
   
   TOKEN_SECRET=
   TOKEN_EXPIRES=604800
   
   DB_URL=mongodb://localhost/mydatabase
   DB_USER=
   DB_PASS=
   ```
   

3. Generate a new TOKEN_SECRET using this command:

   $ node run secret:generate
   
   Secret key updated successfully!

4. Create the administrator user using this command:

   $ node run user:create
   
   First Name *: basem
   Last Name *: khirat
   Email *: [e-mail]
   Password *: ********
   
   User created successfully!

Environments

• For developement: set the NODE_ENV=development and APP_DEBUG=true in .env file and run the dev command.

$ npm run dev

• For production: set the NODE_ENV=production and APP_DEBUG=false in .env file and run the start command.

$ npm start

Server will listen at port 3000 by default. you can change the port later from app configurations.

Here you can browse your API Documentation http://localhost:3000/api/v1/docs

Documentation

• Routes

• Controllers

• Middlewares

• Request

• Response

• Models

• Authentication

• Authorization

• Public Assets

• Commands

• Services:

  • Cache

  • Config

  • HTTP

  • Log

  • Mail

  • Media

  • Storage

  • Validation

• Restful API Documentation

Author

Basem Khirat - [e-mail]

Bugs, Suggestions and Contributions

Thanks to everyone who has contributed to this project!

Please use Github for reporting bugs, and making comments or suggestions.

License

MIT