https://github.com/danilqa/construction-companies-service
https://github.com/danilqa/construction-companies-service
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/danilqa/construction-companies-service
- Owner: Danilqa
- Created: 2022-09-18T07:00:21.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-19T07:42:28.000Z (almost 4 years ago)
- Last Synced: 2025-08-12T16:51:46.207Z (12 months ago)
- Language: TypeScript
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# About
Company catalog service
# API
| Route | Description |
|--------------|------------------------------------------------------------------|
| Companies | `/companies?query=:query&specialities=:speciality1,:speciality2` |
| Specialities | `/specialities` |
# Getting started
1. `yarn install` - install the dependencies
2. `yarn dev` - start on the localhost at `3500` port
# Why do we have these dependencies?
* `fastify` - maintainable and fast web-framework with good api
* `@fastify/cors` - configures CORS on fastify
# Project structure
```
/config - files for configuration project modules
/src - files used by this application (modules, templates, logic)
/assets - mock data
/repository
/model - domain entities
/utils - helpers
/env - sets of constants for the app environment
env.ts
server.tsx - the main app
package.json - project configuration, contains project information, dependencies and settings
yarn.log - file fixing specific dependency numbers
README.md
- for example, jest.config.ts, .gitignore, ...
```