{"id":20538318,"url":"https://github.com/basemkhirat/dotapp-framework","last_synced_at":"2025-04-14T07:50:51.685Z","repository":{"id":116892182,"uuid":"266809550","full_name":"basemkhirat/dotapp-framework","owner":"basemkhirat","description":"A light-weight, thin and full-featured Node.js framework built on express.js","archived":false,"fork":false,"pushed_at":"2023-12-04T02:15:50.000Z","size":31685,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T21:23:32.057Z","etag":null,"topics":["acl","cli","expressjs","filesystem","i18n","mongoose","mvc","nodejs","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/basemkhirat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-05-25T15:05:58.000Z","updated_at":"2023-12-04T01:38:43.000Z","dependencies_parsed_at":"2023-12-04T02:31:35.095Z","dependency_job_id":"330763d1-8862-4a3d-8bd1-9f3ac6934fd9","html_url":"https://github.com/basemkhirat/dotapp-framework","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basemkhirat%2Fdotapp-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basemkhirat%2Fdotapp-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basemkhirat%2Fdotapp-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basemkhirat%2Fdotapp-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/basemkhirat","download_url":"https://codeload.github.com/basemkhirat/dotapp-framework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248844049,"owners_count":21170486,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acl","cli","expressjs","filesystem","i18n","mongoose","mvc","nodejs","swagger"],"created_at":"2024-11-16T00:46:17.885Z","updated_at":"2025-04-14T07:50:51.659Z","avatar_url":"https://github.com/basemkhirat.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cdiv style=\"text-align:center\"\u003eDotApp\u003c/div\u003e\n\nA tiny, light-weight and full-featured nodejs framework built on express.js.\n\nDOTAPP is shipped with a combination of open-source libraries that are fully integrated to save the development time like users, roles an media.\n\n## Requirements\n\n- nodejs \u003e= 12.0.0\n- git\n- mongodb\n\n## Installation\n\n```bash\n$ git clone https://github.com/basemkhirat/dotapp-framework blog\n$ cd blog\n$ npm install\n```\n\n## Configuration\n\n1. Rename the file `.env.example` to `.env`.\n2. Change configurations in `.env` according to your environment.\nThe `.env` file appears like this:\n\n    ``` bash\n    NODE_ENV=development\n    APP_DEBUG=true\n    APP_URL=http://localhost:3000\n    APP_PORT=3000\n\n    TOKEN_SECRET=\n    TOKEN_EXPIRES=604800\n\n    DB_URL=mongodb://localhost/mydatabase\n    DB_USER=\n    DB_PASS=\n    ```\n\n3. Generate a new TOKEN_SECRET using this command:\n\n    ``` bash\n    $ node run secret:generate\n\n    Secret key updated successfully!\n    ```\n4. Create the administrator user using this command:\n\n    ``` bash\n    $ node run user:create\n\n    First Name *: basem\n    Last Name *: khirat\n    Email *: basemkhirat@gmail.com\n    Password *: ********\n\n    User created successfully!\n    ```\n\n\n## Environments\n\n- For `developement`: set the `NODE_ENV=development` and\n`APP_DEBUG=true` in `.env` file and run the `dev` command.\n\n``` bash\n$ npm run dev\n```\n\n- For `production`: set the `NODE_ENV=production` and\n`APP_DEBUG=false` in `.env` file and run the `start` command.\n\n``` bash\n$ npm start\n```\n\nServer will listen at port 3000 by default. you can change the port later from app configurations.\n\n\nHere you can browse your API Documentation `http://localhost:3000/api/v1/docs`\n\n## Documentation\n\n\n- [Routes](https://github.com/basemkhirat/dotapp-core/blob/master/manual/routes.md)\n\n- [Controllers](https://github.com/basemkhirat/dotapp-core/blob/master/manual/controllers.md)\n\n- [Middlewares](https://github.com/basemkhirat/dotapp-core/blob/master/manual/middlewares.md)\n\n- [Request](https://github.com/basemkhirat/dotapp-core/blob/master/manual/request.md)\n\n- [Response](https://github.com/basemkhirat/dotapp-core/blob/master/manual/response.md)\n\n- [Models](https://github.com/basemkhirat/dotapp-core/blob/master/manual/models.md)\n\n- [Authentication](https://github.com/basemkhirat/dotapp-core/blob/master/manual/authentication.md)\n\n- [Authorization](https://github.com/basemkhirat/dotapp-core/blob/master/manual/authorization.md)\n\n- [Public Assets](https://github.com/basemkhirat/dotapp-core/blob/master/manual/public.md)\n\n- [Commands](https://github.com/basemkhirat/dotapp-core/blob/master/manual/commands.md)\n\n\n- Services:\n\n    - [Cache](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/cache.md)\n\n    - [Config](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/config.md)\n\n    - [HTTP](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/http.md)\n\n    - [Log](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/log.md)\n\n    - [Mail](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/mail.md)\n\n    - [Media](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/media.md)\n\n    - [Storage](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/storage.md)\n\n    - [Validation](https://github.com/basemkhirat/dotapp-core/blob/master/manual/services/validation.md)\n\n- [Restful API Documentation](https://github.com/basemkhirat/dotapp-core/blob/master/manual/docs.md)\n\n\n## Author\n[Basem Khirat](http://basemkhirat.com) - [basemkhirat@gmail.com](mailto:basemkhirat@gmail.com)\n\n\n## Bugs, Suggestions and Contributions\n\nThanks to [everyone](https://github.com/basemkhirat/dotapp-framework/graphs/contributors)\nwho has contributed to this project!\n\nPlease use [Github](https://github.com/basemkhirat/dotapp-framework) for reporting bugs,\nand making comments or suggestions.\n\n## License\n\nMIT\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemkhirat%2Fdotapp-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasemkhirat%2Fdotapp-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemkhirat%2Fdotapp-framework/lists"}