SailingSpot

📗 Table of Contents

📗 Table of Contents
📖 [Sailing_Spot]

📖 [Sailing_Spot]

[Sailing_Spot] is a full-stack web application that enables users to reserve boats. The application was developed using the Ruby on Rails framework for the back-end, and React for the front-end. With this application, users can easily browse available boats, select a desired boat, and reserve it for a specified period of time. The application offers a user-friendly and intuitive interface, making the process of reserving a boat easy and straightforward.

🛠 Built With

Tech Stack

React

React.js

Ruby on Rails

Ruby on Rails

Database

PostgreSQL

Webpack

Webpack

Key Features

[Boats]
[reservations]
[Users]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

Incomming..

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Before you go ahead with this project, please make sure you have: - Basic understanding of HTML and CSS. - JavaScript fundamentals (object, array, conditionals etc). - Familiarity with JavaScript ES6 features (class syntax, arrow functions, object destructuring etc). - Basic understanding of basic Ruby concepts. - Ruby fundamentals (classes, modules, blocks, etc).
Make sure you have Ruby installed in your system. You can install it here
Get started with Ruby on Rails.
Make sure you have PostgreSQL installed and running.
Node and npm are installed. Here are the versions I'll be using while making this tutorial:

```shell
$ node --version
v16.13.2
$ npm --version
8.1.2
$ yarn --version
1.22
```
> Installing npm adds two commands to the system—`npm` and `npx`—both of which I'll be using while making this tutorial.

Git is installed. Here's the version I'll be using while making this tutorial:

```shell
$ git --version
git version 2.29.1.windows.1
```

A GitHub account.
Ruby are installed. Here are the versions I'll be using while making this tutorial:

```shell
$ ruby --version
ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x64-mingw-ucrt]
```
> Installing ruby add the command to the system—`irb` which we'll be using while making this tutorial.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:CakeInTech/SailingSpot.git

Install

Install this project with:

  cd SailingSpot
  bundle install
  yarn install

Run

Change/include host, username, password according to your database server.
Run rails db:create and rails db:migrate
Run rails db:seed to enter some data into database.
Run ./bin/dev to start the server.
In your browser, go to http://localhost:3000.

Test

Run gem install rspec to install Rspec,
Run rspec spec to run all the test cases, and
Run rspec spec/models to run test cases for models.
Run rspec spec/requests to run test cases for controllers.
Run rspec spec/features to run test cases for views.
Run rspec spec/intergration to run test cases for swagger api endpoint.
Run rspec spec/filepath/filename.rb to run test cases individually.

Usage

To run and test as admin use the email: admin@gmail.com and password: 123456
To run and test as user use the email: user@gmail.com and password: 123456

(back to top)