Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
--require spec_helper
--order rand
--no-fail-fast
--format documentation
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ group :development, :test do
gem "debug", platforms: %i[ mri mingw x64_mingw ]
gem "rspec-rails", "~> 5.1"
gem 'guard-rspec', require: false
gem 'simplecov', require: false
end

group :development do
Expand Down
15 changes: 8 additions & 7 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,6 @@ GEM
coderay (1.1.3)
concurrent-ruby (1.1.9)
crass (1.0.6)
database_cleaner (2.0.1)
database_cleaner-active_record (~> 2.0.0)
database_cleaner-active_record (2.0.1)
activerecord (>= 5.a)
database_cleaner-core (~> 2.0.0)
database_cleaner-core (2.0.1)
debug (1.4.0)
irb (>= 1.3.6)
reline (>= 0.2.7)
Expand All @@ -93,6 +87,7 @@ GEM
warden-jwt_auth (~> 0.6)
diff-lcs (1.5.0)
digest (3.1.0)
docile (1.4.0)
domain_name (0.5.20190701)
unf (>= 0.0.5, < 1.0.0)
dotenv (2.7.6)
Expand Down Expand Up @@ -264,6 +259,12 @@ GEM
rspec-support (~> 3.10)
rspec-support (3.11.0)
shellany (0.0.1)
simplecov (0.21.2)
docile (~> 1.1)
simplecov-html (~> 0.11)
simplecov_json_formatter (~> 0.1)
simplecov-html (0.12.3)
simplecov_json_formatter (0.1.4)
strscan (3.0.1)
thor (1.2.1)
timeout (0.2.0)
Expand All @@ -289,7 +290,6 @@ PLATFORMS

DEPENDENCIES
bootsnap
database_cleaner (~> 2.0)
debug
devise (~> 4.8)
devise-jwt (~> 0.9.0)
Expand All @@ -303,6 +303,7 @@ DEPENDENCIES
rack-cors (~> 1.1)
rails (~> 7.0.2, >= 7.0.2.3)
rspec-rails (~> 5.1)
simplecov
tzinfo-data

RUBY VERSION
Expand Down
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 IMMOTEP

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
60 changes: 47 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,58 @@
# README
<h1 align="center">Welcome to IMMOTEP API 👋</h1>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-1.1.0-blue.svg?cacheSeconds=2592000" />
<a href="https://github.com/istarengwa/Immotep_API" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<a href="#" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
</a>
</p>

This README would normally document whatever steps are necessary to get the
application up and running.
> Investir dans l'immobilier est quelque chose que nous avons (presque) tous déjà rêvé de faire. Que ce soit pour soi-même ou pour espérer en tirer un revenu régulier, nous pouvons très rapidement nous perdre face à la masse des éléments à prendre en compte et leur complexité.Nous nous plaçons ici dans le cas précis d'une personne souhaitant acquérir un bien pour le mettre à la location (et non pas pour faire de l'achat/revente OU en faire sa résidence principale -bien que ces fonctionnalités puissent être développées plus tard pour étendre l'offre). /!\ Ce site n'est pas destiné à mettre en lien les vendeurs et les acheteurs. Lors des visites, certaines informations sont cruciales pour pouvoir faire une analyse objective du potentiel d'un bien (charges, loyer annuel, taux d'occupation...) et il est impératif que le futur acheteur y ait accès pour pouvoir comparer plusieurs biens entre eux et choisir l’investissement qui lui correspondra le mieux. Nous souhaitons donc mettre en place un outil lui permettant de récolter ces informations importantes sans risquer d'en oublier, et d'obtenir une analyse objective des biens qu'il a visités.

Things you may want to cover:
### 🏠 [Homepage](https://immotep.vercel.app/)

* Ruby version
### ✨ [API](https://immotep-api.herokuapp.com/)

* System dependencies
<p align="center">Cette API a été développé depuis Ruby (version 3.0.0) et Ruby On Rails Rails 7.0.2.3, sur une Base De Donnée en PostgreSQL et déployée sur Heroku. </p>

* Configuration
## Install

* Database creation
Il s'agit de l'API de l'application React "Immotep" disponible ici "https://immotep.vercel.app/" et qu'on peut démarrer avec les commandes suivantes, une fois le repository cloné depuis l'adresse suivante : "https://github.com/ophelie-gaudin/Immotep_front_react"

* Database initialization
```sh
npm -i
npm start
```

* How to run the test suite
## Usage

* Services (job queues, cache servers, search engines, etc.)
```sh
You can add Housings to your Projects after you create an account on &#34;https://immotep.vercel.app/register&#34;
```

* Deployment instructions
## Run tests

* ...
```sh
npm react-scripts test
```

## Author

👤 **DELDEM JEREMIE & GAUDIN OPHELIE & MULLER LILIAN**

- Github: [@Jérémie Deldem](https://github.com/8UK0W5K1) [@Ophelie Gaudin](https://github.com/ophelie-gaudin) [@Lilian Muller](https://github.com/ISTARENGWA)
- LinkedIn: [@Jérémie Deldem](https://www.linkedin.com/in/j%C3%A9r%C3%A9mie-deldem-5b36b3217) [@Lilian Muller](https://www.linkedin.com/in/lilianmu/) [@Ophelie Gaudin](https://www.linkedin.com/in/oph%C3%A9lie-gaudin-aa3122222/)

## Show your support

Give a ⭐️ if this project helped you!

<a href="https://www.patreon.com/https:\/\/checkout.stripe.com\/pay\/cs\_test\_a1Bl7Qyw9kBbDBMP8uRG7RoIhdvtErjXN4oS9B1nvyxBKmWHlYFtXHJjo4\#fidkdWxOYHwnPyd1blpxYHZxWjA0TjNnSV9AYFdDMTA1ZlZtPGZwYV0zalx1T3Y0MFVca2NuYk9DZHVdNWFBR3FLSkJrRnxrSnNucUhiZ0M9YDw0YVY1MExxT1MzZmFiN3JVNDFNM2dgf2JONTVKPTM3aGRjQicpJ2hsYXYnP34nYnBsYSc%2FJz01MDQ9ZDJnKDc2NDAoMWZgYCg9NWQyKDYxMjNjZzVmMzc2MDIzYWAwYycpJ2hwbGEnPyc0M2YyZmNkYSg8MDRgKDEzMTAoZDU0MShgNmM2NzFmMjEwMzRhMmQ1NDYnKSd2bGEnPycyNWBgZz0zZyg2ZjQ0KDFjZmMoPDdjMSg2NDNkY2AxMTZgM2MxYGE3MmMneCknZ2BxZHYnP15YKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSd3YGNgd3dgd0p3bGJsayc%2FJ21xcXV2PyoqbGhoanFgdSttYHdqbnBkdXUrZmpoJ3gl">
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
</a>

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
5 changes: 5 additions & 0 deletions coverage/.last_run.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"result": {
"line": 78.38
}
}
Loading