Hospital Finder

Table of Contents

• About the Project

• Build with

• Getting Started

• Installation

• Running

• Screenshots

• File Structure

• Unit Testing

• Running Unit tests

• License

About The Project

Hospital Finder is an online web app that helps locate all the hospitals within a given area.

Build with

• React JS
• React Router
• Ant Design
• Firebase
• GraphQL
• Apollo
• Jest
• Enzyme
• Axios

Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructions.

Installation

1. Clone the repository

$ git clone https://github.com/abdulsamadola/enye-challenge-1.git

2. Navigate to repository directory

$ cd enye-challenge-1

3. Install dependencies

$ yarn install

Running

1. Running on development mode

$ yarn run server
$ yarn run client

2. Build for production

$ yarn run build

Screenshots

---

---

---

---

File Structure

|-- Hospital Finder
    |-- .DS_Store
    |-- .env
    |-- .gitignore
    |-- LICENSE
    |-- README.md
    |-- package.json
    |-- server.js
    |-- tsconfig.json
    |-- yarn-error.log
    |-- yarn.lock
    |-- build
    |   |-- favicon.ico
    |   |-- logo192.png
    |   |-- logo512.png
    |   |-- manifest.json
    |   |-- robots.txt
    |-- public
    |   |-- favicon.ico
    |   |-- index.html
    |   |-- logo192.png
    |   |-- logo512.png
    |   |-- manifest.json
    |   |-- robots.txt
    |-- screenshots
    |   |-- 1.png
    |   |-- 2.png
    |   |-- 3.png
    |   |-- 4.png
    |   |-- 5.png
    |-- server
    |   |-- schema
    |       |-- index.js
    |-- src
        |-- .DS_Store
        |-- App.scss
        |-- App.tsx
        |-- index.css
        |-- index.tsx
        |-- react-app-env.d.ts
        |-- setupTests.ts
        |-- Services
        |   |-- dataService.ts
        |   |-- firebase.ts
        |-- __tests__
        |   |-- Footer.test.tsx
        |   |-- Header.test.tsx
        |-- common
        |   |-- index.d.ts
        |-- components
        |   |-- CardTemplate
        |   |   |-- CardTemplate.scss
        |   |   |-- CardTemplate.tsx
        |   |-- Footer
        |   |   |-- Footer.tsx
        |   |-- Header
        |   |   |-- Header.tsx
        |   |-- Home
        |   |   |-- Home.scss
        |   |   |-- Home.tsx
        |   |-- LandingPage
        |   |   |-- LandingPage.tsx
        |   |-- ShowHospitals
        |   |   |-- ShowHospitals.scss
        |   |   |-- ShowHospitals.tsx
        |   |-- SignIn
        |   |   |-- SignIn.tsx
        |   |-- SignUp
        |       |-- SignUp.tsx
        |-- hooks
        |   |-- index.ts
        |   |-- useDebounce.ts
        |-- queries
        |   |-- index.ts
        |-- routes
        |   |-- Auth.tsx
        |   |-- PrivateRoute.tsx
        |   |-- index.tsx
        |-- styles
        |   |-- index.ts
        |-- testUtils
        |   |-- index.ts
        |-- utils
            |-- index.ts

Unit testing

Each component in this project has its own unit test file separately inside __tests__ directory eg. Header.test.tsx

Running Unit tests

Run the following command.

yarn run test

License

This software is licensed under MIT License, See License for more information ©Abdulsamad Suleiman.