ContactsRealmWebApp

Application to demonstrate how to use Realm Sync with a Web App to do basic operations (CRUD)

Live Example

This is the live example of the Web application running

Description

This application will list a table of contacts added to Mongo Realm and will synchronize the data with Realm Sync.

Operation allowed:

1. Log in with Email/Password or Google
2. Show list of contacts
3. Create a new contact
4. Update contact
5. Delete contact

Dependencies & Prerequisites

This application is self-contained in a Docker container. You need to set several things in order to build and run this application.

Mongo Realm & Docker

1. You need to add your Realm Id to api.files/routes/app.js file in order to be able to open a Realm with your Realm Cloud. For this, this project uses the library dotenv to be able to load secrets to your application. This library is listed in the package.json.
2. To be able to use this project, you will need to create a .env file. You could use the .env.template as a template. You will need:
3. Change .env variables to match your working directory.
   1. CLIENT_PATH: Is the directory where you've clone this project plus the folder /api.files.
   2. BACKEND_PATH: Is the directory where you've clone this project.
   3. NGINX_APIX_LOGS: Is the directory where you want to store the client logs file
   4. APP_ID From your Realm Cloud App.
   5. CLIENT_ID From your Google Credentials Project.

Example of a .env file:

# Application's path (absolute or relative)
CLIENT_PATH={{current-directory}}/api.files/
BACKEND_PATH={{current-directory}}

# Logs path
NGINX_APIX_LOGS={{current-directory}}/logs/nginx/

# Secrets
CLIENT_ID=
APP_ID=

Packages needed

This project is based on NodeJS and Bootstrap. These are the libraries used in this project:

• npm
• express
• nodemon
• realm
• socket
• cors
• bson

All these libraries are in the package.json. When executing a docker-compose up --build -d all the packages are automatically installed.

Step by Step

Follow the link to the Wiki page for a step by step instruccionts on how to run this application.