https://github.com/mariaseverino/compass-challenge1
https://github.com/mariaseverino/compass-challenge1
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mariaseverino/compass-challenge1
- Owner: mariaseverino
- Created: 2023-07-31T01:23:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T21:11:15.000Z (almost 2 years ago)
- Last Synced: 2023-11-29T02:28:47.367Z (over 1 year ago)
- Language: TypeScript
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Challenge #01
Description •
Technologies •
Architecture •
How to run the application
## ✨ Description
A client hired Compass to build a new microservice for its veterinary franchise. This microservice will be used by all the clinics they own for internal client and attendances management.
So, you have this new mission, to build the POC foundations of this brand new microservice, so the sales and management team can have the primary technical view of the needs
that the client has.
## ⚡️ Technologies
- Node
- Typescript
- Express
- Mongoose
- Vitest
- Date-fns
- Eslint
- Prettier
## 🗃️ Architecture
```
├── src
│ ├── app
│ │ ├── pet
│ │ └── tutor
│ ├── entities
│ │ ├── pet
│ │ └── tutor
│ └── infra
```
## 🤔 How to run the application
### 🚨 Prerequisite
Before you begin, you will need to have Node.js installed on your machine.
It was used a Docker Mongo container as the database.
```bash
$ docker run --name MongoDB --restart unless-stopped -p 27017:27017 -d mongo
```
```bash
# Clone this repository
$ git clone https://github.com/mariaseverino/compass-challenge1.git
# Access the project folder
$ cd compass-challenge1
# Install the dependencies
$ npm install
# Run the application
$ npm run dev
# Run the tests
$ npm run test
# Docs
$ http://localhost:3000/api/docs
```
### 🔖 Using the API
Insomnia was used to check the API requests.
Maria Rita de Souza Severino [email protected]