https://github.com/rafaelandrade/wmh-backoffice
https://github.com/rafaelandrade/wmh-backoffice
postgresql typescript
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rafaelandrade/wmh-backoffice
- Owner: rafaelandrade
- Created: 2021-09-16T02:33:43.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-16T00:34:30.000Z (over 4 years ago)
- Last Synced: 2025-05-12T21:46:06.208Z (about 1 year ago)
- Topics: postgresql, typescript
- Language: TypeScript
- Homepage:
- Size: 451 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
WhereIsMyHome - backoffice
----
Project created with focus on help to find the best place to live without have to do a bunch of clicks.
-----------
[](https://codecov.io/gh/rafaelandrade/wmh-backoffice)
[](https://deepsource.io/gh/rafaelandrade/wmh-backoffice/?ref=repository-badge)
⭐ Star us on GitHub — it motivates us a lot!
----
👉 Quick start
This is a Typescript project focused on handlers with database requests like update, creation, and selection. The proposition for the creation of this microservice is for don't have to make a connection of the database in all microservices and only he is responsible for it.
----
🔌 Technologies
- Docker
- [Sentry](https://docs.sentry.io/)
- [Coralogix](https://coralogix.com/integrations/coralogix-python-integration/)
- [Prisma](https://www.prisma.io/docs/concepts/overview/what-is-prisma)
- [Jest](https://jestjs.io/docs/getting-started)
----
⚡️ First steps:
The project used `yarn` library. In case of not being installed should follow these [tutorial](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
```bash
# Clone this repository
$ git clone https://github.com/rafaelandrade/wmh-backoffice.git
# Access the project folder in the terminal/cmd
$ cd wmh-backoffice
# Install the dependencies
$ yarn install
# Remember to clone the .env.example file to an .env file and fill the file.
# Already is created a docker to initialiaze a postgres database and already have some data
# only need to run.
# It's recommended to run docker compose up in an new terminal tab.
docker compose up
# To execute the server just need to run
yarn dev:server
```
---
🧚 Executing Tests
To execute the test is simple, have the options:
- Run `yarn run test` for test with coverage
- Run `yarn run test:unit` for run test created or changed
- Run `yarn run test:ci` going to execute the test equal in GitHub actions
---
🍕 Project assistance - Buy me a coffe
If you want to say thank you or/and support active development of WMH.
- Add a GitHub 🌟 to the project.
- Tweet and comment about project.
- Give was a coffee, if you like too.
---
Contributing
Would you like to contribute to this project? [CONTRIBUTING.md](CONTRIBUTING.md) has all the details on how to do that.
---
⚠️ License
WMH-Backoffice is licensed under the terms of the GPL Open Source license and is available for free.