|
| 1 | +<p align="center" > |
| 2 | + <img src="docs/images/logo.png" title="Casame" width="200"> |
| 3 | +</p> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <a href="./LICENSE" target="_blank"> |
| 7 | + <img alt="MIT License" src="https://img.shields.io/github/license/Property-Search-Engine/admin-server" /> |
| 8 | + </a> |
| 9 | + |
| 10 | + <img alt="node-build" src="https://img.shields.io/github/workflow/status/Property-Search-Engine/admin-server/NodeJS?logo=node.js" /> |
| 11 | + |
| 12 | + <img alt="pr" src="https://img.shields.io/github/issues-pr/Property-Search-Engine/admin-server" /> |
| 13 | + <img alt="issues" src="https://img.shields.io/github/issues/Property-Search-Engine/admin-server" /> |
| 14 | + <img alt="discord-chat" src="https://img.shields.io/discord/803927161806520340?logo=discord" /> |
| 15 | +</p> |
| 16 | + |
| 17 | +<h1 align="center">CasaMe: Find the house or office of your dreams</h1> |
| 18 | + |
| 19 | +> CasaMe Service admin dashboard backend |
| 20 | +
|
| 21 | +## Configure |
| 22 | + |
| 23 | +Make sure that you have **Docker** & **Docker Compose** installed on your system |
| 24 | +so you can easily follow the next steps! |
| 25 | + |
| 26 | +Before running the project, first copy the .env.save file: |
| 27 | + |
| 28 | +```bash |
| 29 | +$ cp .env.example .env |
| 30 | +``` |
| 31 | + |
| 32 | +Then setup all the needed env variables and everything should be up to go! |
| 33 | +## Run |
| 34 | + |
| 35 | +We provide you with a set of tools that can help you to automate the building |
| 36 | +and running process throughout makefiles and docker-compose files. |
| 37 | + |
| 38 | +```bash |
| 39 | +$ make run_start |
| 40 | +# remember to execute `make down` when you are done |
| 41 | +``` |
| 42 | + |
| 43 | +Run watch to restart the server on each change |
| 44 | + |
| 45 | +```bash |
| 46 | +$ make run_dev |
| 47 | +# remember to execute `make down` when you are done |
| 48 | +``` |
| 49 | + |
| 50 | +## Test ✅ |
| 51 | + |
| 52 | +```bash |
| 53 | +$ make test_watch |
| 54 | +``` |
| 55 | + |
| 56 | +This is going to run all the tests inside a docker environment. If you want to |
| 57 | +have more control over how the tests are performed, you can run: |
| 58 | + |
| 59 | +```bash |
| 60 | +$ make up |
| 61 | +> $ npm run test # ex. |
| 62 | +``` |
| 63 | + |
| 64 | +## 👤 Contributors ✨ |
| 65 | + |
| 66 | +<table> |
| 67 | +<tr> |
| 68 | +<td align="center"><a href="https://github.com/JasterV"><img src="https://avatars3.githubusercontent.com/u/49537445?v=4" width="100" alt=""/><br /><sub><b>Victor Martínez</b></sub></a></td> |
| 69 | +<td align="center"><a href="https://github.com/devmxhv"><img src="https://avatars.githubusercontent.com/u/18093090?s=400&u=f1be9a47c65f930f7cb6948fe3a606fdac42c197&v=4" width="100" alt=""/><br /><sub><b>devmxhv</b></sub></a></td> |
| 70 | +<td align="center"><a href="https://github.com/Damantino"><img src="https://avatars.githubusercontent.com/u/50982542?s=400&u=94fbe1218e4fb44f5443848c1a586a087dfc773f&v=4" width="100" alt=""/><br /><sub><b>Daniel García</b></sub></a></td> |
| 71 | +</tr> |
| 72 | + |
| 73 | +</table> |
| 74 | + |
| 75 | +## Show your support |
| 76 | + |
| 77 | +Give a ⭐️ if this project helped you! |
0 commit comments