Skip to content

rafaelandrade/wmh-backoffice

Repository files navigation

WhereIsMyHome - backoffice


Project created with focus on help to find the best place to live without have to do a bunch of clicks.



codecov DeepSource

⭐ 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


⚡️ First steps:

The project used yarn library. In case of not being installed should follow these tutorial.

# 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.

Buy Me A pizza


Contributing

Would you like to contribute to this project? 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.

About

No description or website provided.

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages