README.md

Crashpad

Crashpad is an online system for listing and booking short-term rentals.
Available nowhere

Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running
3. License
4. Contact

About The Project

This project started as a project in my software engineering class. Unfortunately for us, the course was over the summer of 2020 and no actual software was written, only documents. In that course, I learned how to discuss the technical requirements of a project with a group and present those ideas to a shareholder (our professor).
This web application is the result of me wanting to turn that project into a reality.

Built With

• Mongodb
• Express
• React
• Node.js
• TailwindCSS
• PassportJS
• Google OAuth2

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

These are the things you need to get Crashpad fully up and running on your machine.

• npm

  npm install npm@latest -g

• Check versions

  node -v
  npm -v

• Install mongodb

sudo apt-get install mongodb

• Create file for mongodb

  sudo mkdir /data && touch /data/db

Installation

1. Clone the repo

   git clone https://github.com/AaronElam/crashpad.git

2. npm install in both /frontend and /backend

npm i

3. For frontend, you must install two additional dependencies, babel and typescript. I'll fix this later.

npm i @babel/core@^7.13.0
npm i typescript@>=2.8.0

4. Done

Running

Open up 3 terminal tabs.

1. Frontend

cd crashpad/frontend/ && npm start

2. Backend

cd crashpad/backend/ && node server.js

3. Database

mongod

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Aaron Elam

Project Link: https://github.com/burzt/crashpad