Skip to content

Run from Source

Jump to bottom
Akram El Assas edited this page Apr 5, 2024 · 26 revisions

Below are the instructions to run Movin' In from source code.

Prerequisites

  1. Install git, Node.js, NGINX or IIS, MongoDB and mongosh. If you want to use MongoDB Atlas, you can skip installing and configuring MongoDB.

  2. Configure MongoDB:

mongosh

Create admin user:

db = db.getSiblingDB('admin')
db.createUser({ user: "admin" , pwd: "PASSWORD", roles: ["userAdminAnyDatabase", "dbAdminAnyDatabase", "readWriteAnyDatabase"]})

Replace PASSWORD with a strong password.

Secure MongoDB by changing mongod.conf as follows:

net:
  port: 27017
  bindIp: 0.0.0.0

security:
  authorization: enabled

Restart MongoDB service.

Instructions

  1. Clone Movin' In repo:
git clone https://github.com/aelassas/movinin.git
  1. Create api/.env file with the following content:
NODE_ENV=development
MI_PORT=4004
MI_HTTPS=false
MI_PRIVATE_KEY=/etc/ssl/movinin.key
MI_CERTIFICATE=/etc/ssl/movinin.crt
MI_DB_URI=mongodb://admin:[email protected]:27017/movinin?authSource=admin&appName=movinin
MI_DB_SSL=false
MI_DB_SSL_CERT=/etc/ssl/movinin.crt
MI_DB_SSL_CA=/etc/ssl/movinin.ca.pem
MI_DB_DEBUG=false
MI_COOKIE_SECRET=COOKIE_SECRET
MI_AUTH_COOKIE_DOMAIN=localhost
MI_JWT_SECRET=JWT_SECRET
MI_JWT_EXPIRE_AT=86400
MI_TOKEN_EXPIRE_AT=86400
MI_SMTP_HOST=smtp.sendgrid.net
MI_SMTP_PORT=587
MI_SMTP_USER=apikey
MI_SMTP_PASS=PASSWORD
[email protected]
MI_CDN_USERS=/var/www/cdn/movinin/users
MI_CDN_TEMP_USERS=/var/www/cdn/movinin/temp/users
MI_CDN_PROPERTIES=/var/www/cdn/movinin/properties
MI_CDN_TEMP_PROPERTIES=/var/www/cdn/movinin/temp/properties
MI_DEFAULT_LANGUAGE=en
MI_BACKEND_HOST=http://localhost:3003/
MI_FRONTEND_HOST=http://localhost:3004/
MI_MINIMUM_AGE=21
MI_EXPO_ACCESS_TOKEN=EXPO_ACCESS_TOKEN

On Windows, install IIS and update the following settings with these values:

MI_CDN_USERS=C:\inetpub\wwwroot\cdn\movinin\users
MI_CDN_TEMP_USERS=C:\inetpub\wwwroot\cdn\movinin\temp\users
MI_CDN_PROPERTIES=C:\inetpub\wwwroot\cdn\movinin\properties
MI_CDN_TEMP_PROPERTIES=C:\inetpub\wwwroot\cdn\movinin\temp\properties

Add full access permissions to the user who is running Movin' In API on C:\inetpub\wwwroot\cdn\movinin.

Then, set the following options:

MI_DB_URI=mongodb://admin:[email protected]:27017/movinin?authSource=admin&appName=movinin
MI_COOKIE_SECRET=COOKIE_SECRET
MI_JWT_SECRET=JWT_SECRET
MI_SMTP_HOST=smtp.sendgrid.net
MI_SMTP_PORT=587
MI_SMTP_USER=apikey
MI_SMTP_PASS=PASSWORD
[email protected]

If you want to use MongoDB Atlas, put you MongoDB Atlas URI in MI_DB_URI otherwise replace PASSWORD in MI_DB_URI with your MongoDB password. Replace JWT_SECRET with a secret token. Finally, set the SMTP options. SMTP options are necessary for sign up. You can use sendgrid or any other transactional email provider.

If you choose sendgrid, create an account on sendgrid.com, login and go to the dashboard. On the left panel, click on Email API, then on Integration Guide. Then, choose SMTP Relay and follow the steps. You will be prompted to create an API Key. Once you create the API Key and verify the smtp relay, copy the API key in MI_SMTP_PASS in ./api/.env. Sendgrid's free plan allows to send up to 100 emails/day. If you need to send more than 100 emails/day, switch to a paid plan or choose another transactional email provider.

COOKIE_SECRET and JWT_SECRET should at least be 32 characters long, but the longer the better. You can use an online password generator and set the password length to 32 or longer.

If you want to enable push notifications in the mobile app, follow these instructions and set the following option:

MI_EXPO_ACCESS_TOKEN=EXPO_ACCESS_TOKEN

Run the api:

cd ./api
npm install
npm run dev
  1. Create backend/.env file with the following content:
PORT=3003
REACT_APP_NODE_ENV=development
REACT_APP_MI_API_HOST=http://localhost:4004
REACT_APP_MI_DEFAULT_LANGUAGE=en
REACT_APP_MI_PAGE_SIZE=30
REACT_APP_MI_PROPERTIES_PAGE_SIZE=15
REACT_APP_MI_BOOKINGS_PAGE_SIZE=20
REACT_APP_MI_BOOKINGS_MOBILE_PAGE_SIZE=10
REACT_APP_MI_CDN_USERS=http://localhost/cdn/movinin/users
REACT_APP_MI_CDN_TEMP_USERS=http://localhost/cdn/movinin/temp/users
REACT_APP_MI_CDN_PROPERTIES=http://localhost/cdn/movinin/properties
REACT_APP_MI_CDN_TEMP_PROPERTIES=http://localhost/cdn/movinin/temp/properties
REACT_APP_MI_AGENCY_IMAGE_WIDTH=60
REACT_APP_MI_AGENCY_IMAGE_HEIGHT=30
REACT_APP_MI_PROPERTY_IMAGE_WIDTH=300
REACT_APP_MI_PROPERTY_IMAGE_HEIGHT=200
REACT_APP_MI_MINIMUM_AGE=21
REACT_APP_MI_PAGINATION_MODE=classic

REACT_APP_MI_PAGINATION_MODE: You can choose between classic or infinite_scroll. This option defaults to classic. If you choose classic, you will get a classic pager with next and previous buttons on desktop and infinite scroll on mobile. If you choose infinite_scroll, you will get infinite scroll on desktop and mobile.

Run the backend:

cd ./backend
npm install
npm start
  1. Create frontend/.env file with the following content:
PORT=3004
REACT_APP_NODE_ENV=development
REACT_APP_MI_API_HOST=http://localhost:4004
REACT_APP_MI_RECAPTCHA_ENABLED=false
REACT_APP_MI_RECAPTCHA_SITE_KEY=GOOGLE_RECAPTCHA_SITE_KEY
REACT_APP_MI_DEFAULT_LANGUAGE=en
REACT_APP_MI_PAGE_SIZE=30
REACT_APP_MI_PROPERTIES_PAGE_SIZE=15
REACT_APP_MI_BOOKINGS_PAGE_SIZE=20
REACT_APP_MI_BOOKINGS_MOBILE_PAGE_SIZE=10
REACT_APP_MI_CDN_USERS=http://localhost/cdn/movinin/users
REACT_APP_MI_CDN_PROPERTIES=http://localhost/cdn/movinin/properties
REACT_APP_MI_AGENCY_IMAGE_WIDTH=60
REACT_APP_MI_AGENCY_IMAGE_HEIGHT=30
REACT_APP_MI_PROPERTY_IMAGE_WIDTH=300
REACT_APP_MI_PROPERTY_IMAGE_HEIGHT=200
REACT_APP_MI_MINIMUM_AGE=21
REACT_APP_MI_PAGINATION_MODE=classic

reCAPTCHA is by default disabled. If you want to enable it, you have to set REACT_APP_MI_RECAPTCHA_ENABLED to true and REACT_APP_MI_RECAPTCHA_SITE_KEY to Google reCAPTCHA site key.

Run the frontend:

cd ./frontend
npm install
npm start
  1. If you want to run the mobile app, create mobile/.env file with the following content:
MI_API_HOST=https://movinin.io:4004
MI_DEFAULT_LANGUAGE=en
MI_PAGE_SIZE=20
MI_PROPERTIES_PAGE_SIZE=8
MI_BOOKINGS_PAGE_SIZE=8
MI_CDN_USERS=https://movinin.io/cdn/movinin/users
MI_CDN_PROPERTIES=https://movinin.io/cdn/movinin/properties
MI_AGENCY_IMAGE_WIDTH=60
MI_AGENCY_IMAGE_HEIGHT=30
MI_PROPERTY_IMAGE_WIDTH=300
MI_PROPERTY_IMAGE_HEIGHT=200
MI_MINIMUM_AGE=21

Set the following options:

MI_API_HOST=https://movinin.io:4004
MI_CDN_USERS=https://movinin.io/cdn/movinin/users
MI_CDN_PROPERTIES=https://movinin.io/cdn/movinin/properties

You need to replace https://movinin.io with an IP or hostname.

  1. Configure http://localhost/cdn
  • On Windows, install IIS and createC:\inetpub\wwwroot\cdn\movininfolder. Finally, add full access permissions to the user who is running Movin' In API on C:\inetpub\wwwroot\cdn\movinin.
  • On Linux, install NGINX and add cdn folder by changing /etc/nginx/sites-available/default as follows:
server {
    listen 80 default_server;
    server_name _;
    
    ...

    location /cdn {
      alias /var/www/cdn;
    }
}

Create /var/www/cdn/movinin folder and add full access permissions to the user who is running Movin' In API on /var/www/cdn/movinin.

  1. Create an admin user from http://localhost:3003/sign-up

  2. To run the mobile app simply download Expo app on your device and run the following commands from ./mobile folder:

npm install
npm start

You need to download the google-services.json file and place it in ./mobile root directory for push notifications.

You can find detailed instructions about running the mobile app here.

To change the currency, follow these instructions.

Copyright © 2025 Akram El Assas. All rights reserved.

  1. Overview
  2. Why Use Movin' In
  3. Architecture
  4. Installing (Self-hosted)
  5. Installing (Docker)
    1. Docker Image
    2. SSL
  6. Payment Gateways
  7. Setup Stripe
  8. Build Mobile App
  9. Demo Database
    1. Windows, Linux and macOS
    2. Docker
  10. Run from Source
  11. Run Mobile App
    1. Prerequisites
    2. Instructions
    3. Push Notifications
    4. Run iOS App
  12. Add New Language
  13. Add New Currency
  14. Unit Tests and Coverage
  15. Manual Tests
  16. Logs
  17. FAQ
Clone this wiki locally