• Guaurderia
  • Features
  • High Level Design
  • Tools
  • Getting Started
    • Prerequisites
    • MongoDB Setup
      • Install and Host MongoDB Locally
      • Install And Host Using Docker
        • Run MongoDB Using Named Volume
        • Run MongoDB Using Bind Mount
      • Third Party Hosting
        • MongoDB Atlas
        • MLab
  • Install
    • Server
      • Build server
    • Client
  • Versioning
  • Authors

Guaurderia

Guaurderia app uses a [ReactJS] frontend to capture and manage assistance, an api written in [ReactJS], and [MongoDB] to store data.

Features

• Add admin

High Level Design

---

Tools

• [NodeJS] - Javascript runtime
• [MongoDB] - NoSQL database
• [ReactJS] - Javascript library for building user interfaces

---

Getting Started

These instructions will get your app up and running.

Prerequisites

The following software is required to be installed on your system:

• NodeJS

  The following version of Node and Npm are required:

  • Node 8.x
  • Npm 3.x

  Type the following commands in the terminal to verify your node and npm versions

  node -v
  npm -v

• MongoDB

  MongoDB 3.x is required

  Type the following command to verify that MongoDB is running on your local machine

  mongo -version

  See alternative MongoDB options below

MongoDB Setup

A running instance of MongoDB is required. Alternatively use a hosted MongoDB from MongoDB Atlas or MLab

One of the 3 options below is recommended to get up and running with MongoDB:

• Install and host locally
• Install and host in Docker
• Register for third party MongoDB hosting
  • Register for and use MongoDB Atlas (Database As A Service)
  • Register for and use MLab (Database As A Service)

Install and Host MongoDB Locally

Installing MongoDB is relatively straight forward. There are currently 3 platform (Windows, Linux, OSX) releases available and can be found here

For more specific installation instructions, please see the following links:

• Install MongoDB On Linux

• Install MongoDB On Windows

• Install MongoDB On OSX

Install And Host Using Docker

Run MongoDB Using Named Volume

To run a new MongoDB container, execute the following command from the CLI:

docker run --rm --name mongo-dev -p 127.0.0.1:27017:27017 -v mongo-dev-db:/data/db -d mongo

CLI Command	Description
--rm	remove container when stopped
--name mongo-dev	give container a custom name
-p	map host port to container port
-v mongo-dev-db/data/db	map the container volume 'data/db' to a custom name 'mongo-dev-db'
-d mongo	run mongo container as a daemon in the background

Run MongoDB Using Bind Mount

cd
mkdir -p mongodb/data/db
docker run --rm --name mongo-dev -p 127.0.0.1:27017:27017 -v ~/mongodb/data/db:/data/db -d mongo

CLI Command	Description
--rm	remove container when stopped
--name mongo-dev	give container a custom name
-p	map host port to container port
-v ~/mongodb/data/db/data/db	map the container volume 'data/db' to a bind mount '~/mongodb/data/db'
-d mongo	run mongo container as a daemon in the background

Third Party Hosting

MongoDB Atlas

MongoDB Atlas is basically a database as a service and is hosted in the cloud. That means that you don't need to install or setup anything to start using MongoDB.

You can get started for free by registering here. The free tier entitles you to 512MB storage.

Please review the documentation here

MLab

MLab also provides MongoDB cloud hosting in the form of database as a service. Once again there is no installation or setup required.

To get started, signup for free account here. The free tier entitles you to 500MB storage.

Please review the documentation here

Install

Follow the following steps to get development environment running.

1. Clone 'guaurderia/app' repository from GitHub

   git clone https://github.com/guaurderia/app.git

   or using ssh

   git clone [email protected]:guaurderia/app.git

Server

To start app server, you just need to run this commands:

Build server

cd server
npm install
npm start

[Optional]

To change the default server behaviour you can create an .env file in server root path to declarte the server variables:

vim .env

Example of server variables:

Once .env file is in place, to start the server follow build instructions

Client

To start the app, follow the next instructions:

Start React app

cd client
npm install
npm start

---

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Román Mendez Beck - romanmendez
• Alicia Doblas Alaez - adoblas