{"id":20630720,"url":"https://github.com/sysgears/restapp","last_synced_at":"2025-06-29T18:03:42.795Z","repository":{"id":66053105,"uuid":"180148167","full_name":"sysgears/restapp","owner":"sysgears","description":"RestApp is an SEO-friendly, fully-configured, modular starter application that helps developers to streamline web, server, and mobile development with cutting-edge technologies and ultimate code reuse.","archived":false,"fork":false,"pushed_at":"2023-04-30T20:36:23.000Z","size":2450,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-15T18:14:47.083Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sysgears.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-04-08T12:50:57.000Z","updated_at":"2019-09-03T15:06:42.000Z","dependencies_parsed_at":"2024-01-23T21:36:05.526Z","dependency_job_id":null,"html_url":"https://github.com/sysgears/restapp","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/sysgears/restapp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Frestapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Frestapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Frestapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Frestapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sysgears","download_url":"https://codeload.github.com/sysgears/restapp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Frestapp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262642960,"owners_count":23341816,"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":[],"created_at":"2024-11-16T14:09:21.754Z","updated_at":"2025-06-29T18:03:42.775Z","avatar_url":"https://github.com/sysgears.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# REST App\n\n[![Join the chat at https://gitter.im/sysgears/restapp](https://badges.gitter.im/sysgears/apollo-fullstack-starter-kit.svg)](https://gitter.im/sysgears/restapp?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![Build Status](https://travis-ci.com/sysgears/restapp.svg?branch=master)](https://travis-ci.com/sysgears/restapp)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Twitter Follow](https://img.shields.io/twitter/follow/sysgears.svg?style=social)](https://twitter.com/sysgears)\n\n**Use [our chat] to get help or discuss general topics about REST App.**\n\n## Description\n\nREST App is an SEO-friendly, fully configured, modular starter project for developing [Universal\nJavaScript] applications. You can use REST App to create your applications in JavaScript or TypeScript for all major\nplatforms \u0026ndash; mobile, web, and server.\n\nREST App is built with [REST], [React], [React Native], [Expo], [Knex.js], \nand [Express] with support for relational databases such as PostgreSQL, MySQL, and SQLite. \n\n[TypeScript] is our language of choice and we use it across the entire project. However, you can freely mix vanilla \nJavaScript (the ES6 and ES7 syntax) and TypeScript when creating your modules.\n\nREST App also integrates [Twitter Bootstrap], [Ant Design], [Ant Design Mobile], and [NativeBase] to provide \ngreat possibilities for styling for your web and mobile applications.\n\n## Table of Contents\n\n  * [Overview](#overview)\n    * [Why Use REST App](#why-use-rest-app)\n    * [Concept](#concept)\n    * [Architecture and Implemented Modules](#architecture-and-implemented-modules)\n  * [Demo](#demo)\n  * [First Run of REST App](#first-run-of-rest-app)\n  * [Project Structure](#project-structure)\n  * [REST App Documentation](#rest-app-documentation)\n  * [Support](#support)\n    * [Community Support](#community-support)\n    * [Commercial Support](#commercial-support)\n  * [License](#license)\n\n## Overview\n\n### Why Use REST App\n\n#### I am a Developer\n\n* Great productivity thanks to live reload and (partial) hot code reload\n* Fractal modular architecture that's easy to support and extend\n* The possibility to create modules in TypeScript _and_ JavaScript at the same time\n* No need to develop [typical features](#architecture-and-implemented-modules) for your applications\n* Zero project configuration thanks to [Zen], a builder for JavaScript projects\n\n#### I am a Project Manager\n\n* Your team will be able to reuse the code for all the platforms\n* Your team can create client, server, and mobile JavaScript applications\n* Your application will be easier to support and evolve thanks to the fractal modular architecture\n* Your application will be based on a widely-used JavaScript ecosystem (it's easy to find JS developers)\n* Your team can develop new features straightaway instead of creating the basic features\n\n### Concept\n\nDeveloping client-server-mobile projects in JavaScript never was a trivial task. Not only do you have to spend time\ninstalling the application dependencies and configuring them, but you're also constrained to implement many basic\nfunctionalities over and over again. And you never have time to develop a starter codebase that you can reuse across\nall of your projects.\n\nTo relieve you from the burden of configuring the project, developing the application structure, and implementing \ntypical features, we created REST App.\n\nREST App provides you with a client-server-mobile application that you can employ as a foundation\nfor developing new web or mobile projects using popular tools from the JavaScript ecosystem. But our app does so\nmuch more than just creating a mix of popular JS technologies \u0026mdash; it's powered by a few **custom** libraries and \nsolutions to simplify managing project configurations, creating new modules, building REST API, and perform many \nother tasks.\n\nOne such solution that helps to configure and build REST App-based projects is [Zen], a custom build \ntool that configures the project for all the platforms \u0026mdash; web, server, and mobile. With Zen, we drastically reduced \nthe amount of errors caused by third-party libraries used for building JavaScript projects.\n\nREST App also consists of many modules that you can augment and adapt to develop your specific application. Also,\nyou can use those prebuilt modules as a reference when implementing basic features for your applications even if you \ncreate them using other technologies.\n\n### Architecture and Implemented Modules\n\nAmong all the approaches to building the application architecture, we opt for the _disposable fractal-based modular\narchitecture_. Thanks to this approach, it's possible to remove any built-in module from REST App \nwithout breaking the application. We recommend that you develop your custom modules with the same idea in mind when \nusing our app.\n\nTo learn more about the features and modules available in REST App, follow to the dedicated section \n[Features and Modules].\n\n## Demo\n\nYou can try out the latest version of REST App [deployed on Heroku]. If you want to see the mobile\nReact Native application in action, check out [this demo on Expo.io].\n\n## First Run of REST App\n\nVerify if you use Node.js 6.x or higher (Node.js ^10 is recommended) before running the starter kit.\n\n1. Clone the master branch of REST App.\n\n```\ngit clone https://github.com/sysgears/restapp.git\ncd restapp\n```\n\n**NOTE**: If you're going to use Windows to develop with REST App, you need to additionally enable \nsymlinks _before_ you run the project.\n\nFor Windows 10:\n\n* Press `Win` + `I` to open **Settings**\n* Click **Update \u0026 Security**\n* Click the **For Developers** tab\n* In the **Use developer features** window, switch to **Developer Mode**\n\n2. Install the dependencies. Make sure that you use Yarn 1.0.0 or higher.\n\n```\nyarn\n```\n\nYou can use NPM instead of Yarn to handle the dependencies and to run scripts. Throughout the REST App documentation, we'll always use Yarn.\n\n3. Seed sample data to the database. The command below will create new tables with sample data in SQLite:\n\n```\nyarn seed\n```\n\nSQLite is a typical default relational database installed in most Linux distributions including Mac OS X; otherwise, \nconsult [SQLite installation guide].\n\n4. Run the project in development mode:\n\n```\nyarn watch\n```\n\nThe server application will be running on [http://localhost:3000], while the client application will be running on \n[http://localhost:8080]. The terminal will tell your the exact ports.\n\nFor more information about running REST App for mobile development, consult the [Getting Started] \nguide.\n\n## Project Structure\n\nThe project structure presents generally accepted guidelines and patterns for building scalable web and mobile\napplications.\n\nThe structure is _fractal_ meaning the available functionality is grouped primarily by feature rather than by file type. \nBut the current structure isn't prescriptive, and you can change it however you like.\n\n```\nrestapp\n├── config                      # Various application configurations\n├── docs                        # Documentation\n├── node_modules                # Global Node.js modules\n├── modules                     # All the prebuilt project modules\n├── packages                    # Available packages\n│   ├── client                  # React client\n│   ├── common                  # Common code\n│   ├── mobile                  # React Native mobile client\n│   └── server                  # Node.js and Express server\n└── tools                       # All build and CLI-related files\n```\n\nInside `modules`, you'll find all the prebuilt modules that REST App comes with. Each module under \n`modules` contains sub-directories with module implementations for different technologies. For example, if you look up \nthe module `modules/core`, you'll see the following sub-modules:\n\n```\nrestapp\n├── modules                       # Available packages\n│   ├── core                      # The core module\n│       ├── client-react          # Core functionality for React app\n│       ├── client-react-native   # Core functionality for React Native app\n│       ├── common                # React Native mobile client\n│       └── server-ts             # Core functionality for Express server\n└── tools                         # All build and CLI-related files\n```\n\n## REST App Documentation\n\nFollow to the documentation concerning different aspects of how to run, configure, and develop with REST App.\n\n* [Getting Started]\n    * [Installing and Running REST App]\n    * [Running the Mobile App with Expo]\n    * [Running REST App in a Mobile Simulator]\n* [Running REST App with Docker]\n* [Deploying REST App to Production]\n* [Configuring REST App]\n* [Features and Modules]\n* [Writing Code]\n* [Available Scripts]\n\nTools\n\n* [REST App CLI]\n\n## Support\n\n### Community Support\n\n* [Gitter channel] \u0026ndash; ask questions, find answers, and participate in general discussions\n* [GitHub issues] \u0026ndash; submit issues and send feature requests\n* [Wiki] \u0026ndash; read documentation for the usage scenarios of the starter kit; edit the documentation\n\n### Commercial Support\n\nThe [SysGears] team provides comprehensive support for commercial partners. Our team can guide you when you're using\nREST App to build your application.\n\nYou can contact us via [Skype] or email [info@sysgears.com](mailto:info@sysgears.com).\n\n## License\n\nCopyright \u0026copy; 2016-2019 [SysGears (Cyprus) Limited]. This source code is licensed under the [MIT] license.\n\n[our chat]: https://gitter.im/sysgears/restapp\n[mit]: LICENSE\n[universal javascript]: https://medium.com/@mjackson/universal-javascript-4761051b7ae9\n[jwt]: https://jwt.io\n[react]: https://reactjs.org/\n[angular]: https://angular.io/\n[react native]: https://facebook.github.io/react-native/\n[expo]: https://expo.io/\n[knex.js]: http://knexjs.org\n[express]: http://expressjs.com\n[typescript]: https://www.typescriptlang.org/\n[twitter bootstrap]: http://getbootstrap.com\n[ant design]: https://ant.design\n[ant design mobile]: https://mobile.ant.design\n[nativebase]: https://nativebase.io\n[apollokit.org]: https://apollokit.org\n[zen]: https://github.com/sysgears/larix/tree/master/packages/zen\n[deployed on heroku]: https://restappkit.herokuapp.com\n[this demo on Expo.io]: https://expo.io/@sysgears/restapp\n[master]: https://github.com/sysgears/apollo-universal-starter-kit/tree/master\n[sqlite installation guide]: http://www.sqlitetutorial.net/download-install-sqlite/\n[http://localhost:3000]: http://localhost:3000\n[http://localhost:8080]: http://localhost:8080\n[getting started]: https://github.com/sysgears/restapp/blob/master/docs/gettingStarted.md\n[installing and running rest app]: https://github.com/sysgears/restapp/blob/master/docs/gettingStarted.md#installing-and-running-rest-app\n[running the mobile app with expo]: https://github.com/sysgears/apollo-universal-starter-kit/blob/master/docs/gettingStarted.md#running-the-mobile-app-with-expo\n[running rest app in a mobile simulator]: https://github.com/sysgears/restapp/blob/master/docs/gettingStarted.md#running-rest-app-in-a-mobile-simulator\n[running rest app with docker]: https://github.com/sysgears/apollo-universal-starter-kit/blob/master/docs/docker.md\n[deploying rest app to production]: https://github.com/sysgears/restapp/blob/master/docs/deployment.md\n[configuring rest app]: https://github.com/sysgears/restapp/blob/master/docs/configuration.md\n[features and modules]: https://github.com/sysgears/restapp/blob/master/docs/featuresAndModules.md\n[writing code]: https://github.com/sysgears/restapp/blob/master/docs/writingCode.md\n[rest app cli]: https://github.com/sysgears/restapp/blob/master/docs/tools/cli.md\n[available scripts]: https://github.com/sysgears/restapp/blob/master/docs/yarnScripts.md\n[sysgears (cyprus) limited]: http://sysgears.com\n[gitter channel]: https://gitter.im/sysgears/restapp\n[github issues]: https://github.com/sysgears/restapp/issues\n[wiki]: https://github.com/sysgears/restapp/wiki\n[faq]: https://github.com/sysgears/restapp/wiki/Frequently-Asked-Questions\n[sysgears]: https://sysgears.com\n[skype]: http://hatscripts.com/addskype?sysgears\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysgears%2Frestapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsysgears%2Frestapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysgears%2Frestapp/lists"}