https://github.com/jennypavlova/companies-listing

https://github.com/jennypavlova/companies-listing

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jennypavlova/companies-listing
• Owner: jennypavlova
• Created: 2021-09-25T16:24:42.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-09-27T00:29:47.000Z (over 3 years ago)
• Last Synced: 2024-10-29T23:08:39.351Z (2 months ago)
• Language: TypeScript
• Size: 402 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Companies Listing

# [Client](https://github.com/jennypavlova/companies-listing/tree/master/client)

## Available Scripts

### `npm run start`

Runs on [http://localhost:3000](http://localhost:3000)

### `npm run test`

### `npm run build`

## Screenshots

- Filter by specialty and company name

![specialty_name](images/specialty_name.png)

- Filter by name

![name_no_specialty](images/name_no_specialty.png)

- Filter by specialty

![specialty_no_name](images/specialty_no_name.png)

# [Server](https://github.com/jennypavlova/companies-listing/tree/master/server)

## Prereqiusite

- Node > v14

## Available Scripts

### `npm run start`

Runs on [http://localhost:4000](http://localhost:4000)

### `npm run test`

### `npm run build`

## API endpoints

GET ``api/companies``

```

curl http://localhost:4000/api/companies

```

Returns a list with companies

GET ``api/specialities``

```

curl http://localhost:4000/api/specialities

```

Returns a list with all specialities based on the information in the companies

# Improvements ideas

- Improve the UI/UX:

    - Implement autocomplete on Search

    - Mobile version should be improved with a better layout

- Structure:

    - Combine server part and client part folders in one Monerepo to make it possible to share types and dependencies between them.

    - Add config for differnt enviroments and CI setup for running the tests

- Code Quality and scalability:

    - In case of a big amount of data implement pagination so the server will return only part of the data and the frontend will load it on demand.

    - Add more tests (including an e2e test as well)