README.md

Labby

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Deployment
4. Contributing

About The Project

BC Cancer Lab Management System

Built With

• React JS - Frontend
• Express JS - Backend
• MySQL - Database
• AWS - Hosting

Getting Started

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

Prerequisites

• yarn

Installation

Express Backend

1. cd into backend folder
2. run yarn start

Backend will be exposed on port 3000

React Frontend

1. cd into frontend folder
2. run yarn to install dependencies
3. run yarn start

Docker Setup

1. run docker-compose up --build -d

Deployment

TODO

Contributing

Contributions are what make the community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
2. Commit your Changes (git commit -m 'Add some AmazingFeature')
3. Push to the Branch (git push origin feature/AmazingFeature)
4. Open a Pull Request