franciscoPonceDev / rent-yacht

This is a Web application where users should sign in to rent a Yacht from a list then reserve for a determined period, users can then see their reservations or cancel them.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WISHYACHT

Rails Postgres

License: MIT rails version ruby version


Description

This is a Web application where users should sign in to rent a Yacht from a list then reserve for a determined period, users can then see their reservations or cancel them.


Kanban bord

Api Documentation

You can review the documentation for the API here.


Front-end Repository

ReactApp

Built With

  • Major languages: Ruby, HTML, Javascript, Bootstrap.
  • Frameworks: Ruby on Rails, React&Redux.
  • Tools & Methods: RSpec, PostgreSQL, JWT, Jest, Linters.

Getting Started

If you have Rails 7 installed, you can skip to the Setup section

Clone Repo

First clone this repo by running this command in your terminal:

(https://github.com/algerina/rent-yacht.git)


Prerequisites

The following technologies must be installed in your local machine:

  • Ruby.
  • Postgres ('pg', '~> 1.1')
  • Node.js

Refer to Section 3 from the official Rails Guide for more detailed instructions on how to install these technologies.

Install Rails

To install Rails run these commands in your terminal:

gem install rails
# wait a few seconds for it to download
# ...
# ...
# verify that it was installed by running
rails --version

System Dependencies

To automatically install all the dependencies needed run:

bundle install

Database Initialization

To initialize the database created run:

rails db:setup

Start Server

To start the server

rails server

Which you can visit by going to http://localhost:3001 in your browser.


Testing RSpec

Anyway, to run tests located in the spec folder /spec run:

bundle exec rspec spec

How To Contribute?

To contribute you can create a new branch and work on it.

Visit linters folder to learn how to setup linters.

Then check linters locally before pushing by running:

npx stylelint "**/*.{css,scss}"
# ...
# ...
rubocop --color -A

Finally, once your changes have no linter errors and all tests are passing, try to merge your branch into develop by running:

git checkout development
git merge <branchname>

Collaborators

👤 Amel Khiri

Platform Badge
GitHub @Algerina
LinkedIn @Amel Khiri

👤 Edgar Esteban Muñoz Alba

Platform Badge
GitHub @estebanmual
Twitter @estebanmual
LinkedIn LinkedIn

👤 Francisco Ponce

Platform Badge
GitHub @franciscoPonceDev
LinkedIn Francisco Ponce

👤 German Cobian

Platform Badge
GitHub @German Cobian
Twitter @GermanCobian2
LinkedIn @German Cobian

👤 Omar Ragheb

Platform Badge
GitHub @omar25ahmed
Twitter @omar25Ahmed
LinkedIn @Omar-ragheb

Show your support

Give a ⭐️ if you like this project!


Acknowledgments

Original design Vespa by Murat Korkmaz on Behance


📝 License

This project is MIT licensed.

About

This is a Web application where users should sign in to rent a Yacht from a list then reserve for a determined period, users can then see their reservations or cancel them.


Languages

Language:Ruby 99.7%Language:HTML 0.3%