Gravity
  • Welcome to Gravity
  • Getting Started
  • Stack
  • Updates
  • Rules For AI
  • Troubleshooting
  • Gravity Server
    • Introduction
    • Installation
      • Install Node.js
      • Database Setup
      • Stripe Setup
      • Mailgun Setup
      • Install Gravity
    • Application Structure
    • REST API
      • API Scopes
      • Webhooks
    • Authentication
      • Email Verification
      • Social Sign On
      • Two-Factor Authentication
    • Authorization
      • Feature Access and Plan Restrictions
      • Permissions (Roles)
    • Config
    • Environment Variables
    • Database Queries
    • Handling Errors
    • Logging
    • Localization
    • Push Notifications
    • Email Notifications
    • User Feedback
    • User Onboarding
    • File Uploads
    • Billing
      • Seat Billing
      • Usage Billing
    • Free Accounts
    • CLI Toolbelt
    • Testing
    • AI Tools
    • Background Jobs
    • Deployment
  • Gravity Web
    • Introduction
    • Tailwind & SCSS
    • Routing
    • Events
    • Authentication
    • Localization
    • Hooks
      • useAPI
      • usePlans
      • usePermissions
    • Components
      • Alert
      • Animate
      • Avatar
      • Badge
      • Breadcrumb
      • Button
      • Calendar
      • Card
      • Chart
      • Checklist
      • Credit Card
      • Detail
      • Dialog
      • Dropdown
      • Feedback
      • Form
      • Grid
      • Header
      • Helper
      • Icon
      • Image
      • Layout
      • Link
      • List
      • Loader
      • Logo
      • Nav
      • Onboarding
      • Pagination
      • Popover
      • Progress
      • Row
      • Search
      • Separator
      • Sheet
      • Social
      • Stat
      • Table
      • Tabs
      • Toast (Notification)
      • Tooltip
      • User
      • View
    • Views
    • Handling Errors
    • Deployment
  • Gravity Native
    • Introduction
    • Prerequisites
    • Installation
    • App Context
    • Authentication
    • Localisation
    • External Linking
    • Handling Errors
    • Navigation
    • Config
    • Events
    • Views
    • Components
      • Badge
      • Blankslate
      • Button
      • Card
      • Chart
      • Form
      • Global
      • Grid
      • Icon
      • List
      • Logo
      • Message
      • Modal
      • Nav
      • Notification
      • Progress Bar
      • Search
      • Separator
      • Social
      • Stat
      • View
    • Push Notifications
    • Payments
    • Building Your App
  • Mission Control
    • Introduction
    • Installation
    • User Management
    • Feedback
    • Events
    • Logs
  • Website Template
    • Introduction
    • Environment Variables
    • Styling
    • Components
      • Article
      • Feature List
      • Footer
      • Hero
      • Layout
      • Pricing
      • Meta Data
      • Nav
      • Testimonial
    • Build and Deploy
Powered by GitBook
On this page
  • 1. Clone The Repos
  • 2. Install Packages
  • 3. Setup Wizard
  • 4. Clean Up

Was this helpful?

  1. Gravity Server
  2. Installation

Install Gravity

Finally, time for the fun part – let's get your new application running!

1. Clone The Repos

Create a new folder for your project and clone all the repos you were invited to into the project root, eg.

git clone https://github.com/.../server
git clone https://github.com/.../client-react-web
git clone https://github.com/.../mission-control
git clone https://github.com/.../website
git clone https://github.com/.../client-react-native 

You should now have a folder structure with a server subfolder, mission control and at least one client folder, depending on which plan you purchased.

  • server

  • client-react-web

  • client-react-native

  • mission-control

  • website

2. Install Packages

Open up a new terminal window and navigate to the folder where you saved Gravity, go into the server folder and run the following command:

npm run setup

Gravity will also rename the client folders to client and app and install the packages for the server and client(s).

If you experience any issues during this process, you can run a manual install using the following commands.

npm install
npm link
cd client 
npm install

// optional for mobile app
cd app
npm install

3. Setup Wizard

If you're using MongoDB, you will need to run the seed file manually:

node seeds/mongo

Once you have completed these steps, you must restart your node server.

Use the following command to run both the server and the client. Use this from now on any time you want to run your application.

npm run dev

4. Clean Up

You MUST remove the setup files when you have completed the steps above. Failing to do so will let anyone access the setup process.

You can use the cleanup script to automate this for you:

npm run cleanup

If you want to remove the files manually:

  • /client/src/views/setup folder

  • /server/controller/setupController

  • /server/model/setup

  • remove the setup import from /server/api/index.js

  • the setup route import in /client/src/app.js

It's recommended that you run npm audit in each installation folder to ensure third-party packages are up-to-date and secure.

PreviousMailgun SetupNextApplication Structure

Last updated 4 months ago

Was this helpful?

Once the installation has been completed, Gravity will start the server and client and open a new browser window with the homepage, please navigate to .

You'll be presented with the Gravity welcome screen. Follow the instructions on screen to connect to your database and connect your and email accounts.

You can manually configure your application in the folder if you have any problems during setup.

Your browser window will open automatically and you can click on signup and .

http://localhost:3000/setup
Stripe
/config
create an account