README.md

WorkspaceBooking

A full stack workspace booking system for my bachelor thesis

Table Of Contents

• WorkspaceBooking
  • Table Of Contents
  • About the Project
    • External Services
  • Development Environment
    • Requirements
    • Setup

About the Project

This is a full stack MERN application with an Express JS backend connected with a MongoDB and with a React frontend.

External Services

• Database: MongoDB Atlas
• Exception Monitoring: Sentry.io
• Hosted: Heroku

Development Environment

The following steps explain how to start the project on your local machine. It's recommended to use a unix-based operation system.

Requirements

• Node.js v14.15.4
• Docker v20.10.3
• Docker Compose v1.25.0

Setup

1. Clone the Repository and navigate into it

   git clone https://github.com/Elanum/WorkspaceBooking.git && cd WorkspaceBooking

2. Create a .env file in the root directory

   cp .env.example .env

3. Optional: Fill out the variables defined in the .env file. If you don't fill them out, default values will be used.

4. Start the application via docker-compose

   docker-compose up

The app will be available at:

• Frontend (React): http://localhost:3000
• Backend (Express): http://localhost:5000
• Database (MongoDB): http://localhost:27017