Use our chat to get help or discuss general topics about Apollo Universal Starter Kit.
To relieve you from the burden of configuring the project, developing the application structure, and implementing typical features, we created Apollo Universal Starter Kit.
The starter kit also consists of many modules that you can augment and adapt to develop your specific application. Also, you can use those prebuilt modules as a reference when implementing basic features for your applications even if you create them using other technologies.
Among all the approaches to building the application architecture, we opt for the disposable fractal-based modular architecture. Thanks to it, it's possible to remove any built-in module from Apollo Universal Starter Kit without breaking the application. We recommend that you develop your custom modules with the same idea in mind when using our starter kit.
Apollo Universal Starter Kit comes with the following modules:
If you don't want to use the pre-built modules in your project, you can remove them using a dedicated CLI. For module
names, see the names of directories under
To learn more about the features and modules available in Apollo Universal Starter Kit, follow to the dedicated section Features and Modules.
Here's a demo of Apollo Universal Starter Kit in action:
|stable||The latest stable version of the kit (recommended)|
|master||The kit version with the latest features. May not work consistently|
|single||A single-package Apollo v2 version of the kit|
|apollo1||The Apollo v1 version of the kit|
|cli-crud||This kit version features a CLI to generate CRUD implementations|
Verify if you use Node.js 6.x or higher (Node.js ^10 is recommended) before running the starter kit.
git clone -b stable https://github.com/sysgears/apollo-universal-starter-kit.git cd apollo-universal-starter-kit
NOTE: The master branch is not recommended for development. Use it at your own risk.
NOTE: If you're going to use Windows to develop with Apollo Universal Starter Kit, you need to additionally enable symlinks before you run the project.
For Windows 10:
Ito open Settings
NOTE: You can remove the unnecessary stacks from Apollo Universal Starter Kit by using the CLI. Consult a respective CLI section. Alternatively, you can use the capabilities of your operating system. For example, by running the command below, you can remove all Scala server files:
find . -name server-scala | xargs rm -rf
If you don't need the ready-made modules, you can also remove them using the custom CLI.
You can use NPM instead of Yarn to handle the starter kit dependencies and to run scripts. Throughout the Apollo Universal Starter Kit documentation, we'll always use Yarn.
SQLite is a typical default relational database installed in most Linux distributions including Mac OS X; otherwise, consult SQLite installation guide.
For more information about running this starter kit for mobile development or Docker, consult the Getting Started guide.
The project structure presents generally accepted guidelines and patterns for building scalable web and mobile applications.
The structure is fractal meaning the available functionality is grouped primarily by feature rather than by file type. But the current structure isn't prescriptive, and you can change it however you like.
apollo-universal-starter-kit ├── config # Various application configurations ├── docs # Documentation ├── node_modules # Global Node.js modules ├── modules # All the prebuilt project modules ├── packages # Available packages │ ├── client # React client │ ├── client-angular # Angular client │ ├── client-vue # Vue client │ ├── common # Common code │ ├── mobile # React Native mobile client │ ├── server # Node.js and Express server │ └── server-scala # Scala server └── tools # All build and CLI-related files
modules, you'll find all the prebuilt modules that Apollo Universal Starter Kit comes with. Each module under
modules contains sub-directories with module implementations for different technologies. For example, if you look up
modules/core, you'll see the following sub-modules:
apollo-universal-starter-kit ├── modules # Available packages │ ├── core # The core module │ ├── client-angular # Core functionality for Angular app │ ├── client-react # Core functionality for React app │ ├── client-react-native # Core functionality for React Native app │ ├── client-vue # Core functionality for Vue app │ ├── common # React Native mobile client │ ├── server-scala # Core functionality for Scala server │ └── server-ts # Core functionality for Express server └── tools # All build and CLI-related files
Follow to the documentation concerning different aspects of how to run, configure, and develop with Apollo Universal Starter Kit.
The SysGears team provides comprehensive support for commercial partners. Our team can guide you when you're using Apollo Universal Starter Kit to build your application.
Thanks a lot to all the wonderful people who contributed to Apollo Universal Starter Kit!
Thanks a lot to all our backers!
You can support this project by becoming a sponsor! Your logo will show up here with a link to your website.