https://github.com/pamphilemkp/car-reservation

This repo holds the BackEnd development source for the Car Reservation App, the world's best free car reservation website. Car Reservation allows user to add car and see the car model and shop it.
https://github.com/pamphilemkp/car-reservation
rails react redux ruby
Last synced: 8 months ago
JSON representation
This repo holds the BackEnd development source for the Car Reservation App, the world's best free car reservation website. Car Reservation allows user to add car and see the car model and shop it.
Host: GitHub
URL: https://github.com/pamphilemkp/car-reservation
Owner: Pamphilemkp
Created: 2022-12-14T15:41:11.000Z (over 3 years ago)
Default Branch: dev
Last Pushed: 2023-01-09T11:20:13.000Z (over 3 years ago)
Last Synced: 2025-04-01T00:51:10.637Z (about 1 year ago)
Topics: rails, react, redux, ruby
Language: Ruby
Homepage:
Size: 711 KB
Stars: 1
Watchers: 1
Forks: 3
Open Issues: 13
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          



![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white) ![Shell Script](https://img.shields.io/badge/shell_script-%23121011.svg?style=for-the-badge&logo=gnu-bash&logoColor=white) ![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white) ![Rails](https://img.shields.io/badge/rails-%23CC0000.svg?style=for-the-badge&logo=ruby-on-rails&logoColor=white)



# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

>

# 📖 [Car Reservation] 

> This repo holds the BackEnd development source for the Car Reservation App, the world's best free car reservation website. Car Reservation allows user to add car and see the car model and shop it.

## 🛠 Built With 

### Tech Stack 

> Describe the tech stack and include only the relevant sections that apply to your project.

  FrontEnd UI

  


    React-Redux (FrontEnd Repo)

  


### Key Features 

- **[Add an accommodation]**

- **[Make a reservation]**

(back to top)


## Kanban Board

- [Kanban Link](https://github.com/users/Pamphilemkp/projects/3/views/1)

- [Kanban Empty Screen Shot](https://github.com/Pamphilemkp/car-reservation/issues/11)

- Final Members: 5

## 💻 Getting Started 

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to work on this project, you need to have the following dependencies installed:



  Ruby

  Postgresql

  Node.js

  yarn

  Rails



### Setup

Clone this repository to your desired folder:

sh

  git clone https://github.com/Pamphilemkp/car-reservation.git

  cd Budget-app

### Commands to run

To get all the gems required for the project:

  bundle install

To install packages such as style linters:

  npm install

To check linters locally, use:

rubocop

npx stylelint "**/*.{css,scss}"

Once you have the project correctly set up, run:

To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes:

bin/rails db:setup

Finally, each time you make changes to the project, run

In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description:

rspec

## Getting Started

- Check the Ruby version or if you have at all by running `ruby -v` if you get something like this `ruby 2.6.8p205 (2021-07-07 revision 67951)` you have Ruby installed.

- Clone the repository by running `git clone https://github.com/Pamphilemkp/car-reservation.git` in your CLI.

- Type `cd Exploration-Getaways-BACKEND`

- Type `code .`

- Run `bundle install`

#### NOTE  you need to have a master key in config directory. If none exists generate one. 

      - First delete `credentials.yml.enc`

      - Run EDITOR="code" bundle exec rails credentials:edit 

- Run `rails db:create db:migrate`

- Optionally you can run `rails db:seed` to populate it

- Run `rails server` to open the local server

- Open Browser `http://localhost:3000/`

### Usage

To run the project, execute the following command:

  rails server

--->

### Run tests

To run tests, run the following command:

sh

  bin/rails test test/models/article_test.rb

### API Documentation

Open Browser and visit `http://localhost:3000//api-docs/`

![Api Documentation Screenshot ](https://user-images.githubusercontent.com/98436409/211160780-b2cd9819-dc13-4fd8-beed-675c1f25ab96.png)

(back to top)


## 👥 :writing_hand: Authors 

:man_technologist: 👤 **Pamphile Mkp** :writing_hand:

- GitHub:   [@pamphilemkp](https://github.com/pamphilemkp)

- Twitter:  [@pamphilemkp](https://Twitter.com/PamphileMusonda)

- LinkedIn: [@pamphilemkp](https://www.linkedin.com/in/pamphile-musonda)

man_technologist: 👤 **Basit Ali** :writing_hand:

- GitHub: [@githubhandle](https://github.com/basitali111)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/basit-ali-jobs/)

- Twitter: [Twitter](https://twitter.com/BasitAl35031734)

(back to top)


:man_technologist: 👤 **Patrick Maina** :writing_hand:

- GitHub: [@PNdunguMaina](https://github.com/PNdunguMaina)

- LinkedIn: [Patrick Maina](https://www.linkedin.com/in/pndungumaina/)

- Twitter: [@ndunguwamaina_](https://twitter.com/ndunguwamaina_)

:man_technologist: 👤 **Mark otuya** :writing_hand:

- GitHub: [@githubhandle](https://github.com/markotuya0)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mark-otuya)

- Twitter: [Twitter](https://twitter.com/mark_anthonny)

:man_technologist: 👤 **Adebowale Adegboye Monsur** :writing_hand:

- GitHub: [@githubhandle](https://github.com/ademibowale)

- Twitter: [@twitterhandle](https://twitter.com/Ademibowale1)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/adebowale-adegboye-143568221/)

## 🔭 Future Features 

- [ ] **[Allow user to upload avatar]**

- [ ] **[Include "My Profile" section/page]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project or find it useful/interesting, please make sure you give ⭐️ a since this will make it easily accesible for you too!

(back to top)


## 🙏 Acknowledgments 


This work is licensed under a Creative Commons Attribution 4.0 International License.

(back to top)


## 📝 License 

This project is [MIT](./MIT.md) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)

=======

# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

>

# 📖 [Car Reservation] 

> This repo holds the BackEnd development source for the Car Reservation App, the world's best free car reservation website. Car Reservation allows user to add car and see the car model and shop it.

## 🛠 Built With 

### Tech Stack 

> Describe the tech stack and include only the relevant sections that apply to your project.

  FrontEnd UI

  


    React-Redux (FrontEnd Repo)

  


### Key Features 

- **[Add an accommodation]**

- **[Make a reservation]**

(back to top)


## Kanban Board

- [Kanban Link](https://github.com/users/Pamphilemkp/projects/3/views/1)

- [Kanban Empty Screen Shot](https://github.com/Pamphilemkp/car-reservation/issues/11)

- Final Members: 5

## 💻 Getting Started 

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to work on this project, you need to have the following dependencies installed:



  Ruby

  Postgresql

  Node.js

  yarn

  Rails



### Setup

Clone this repository to your desired folder:

sh

  git clone https://github.com/Pamphilemkp/car-reservation.git

  cd Budget-app

### Commands to run

To get all the gems required for the project:

  bundle install

To install packages such as style linters:

  npm install

To check linters locally, use:

rubocop

npx stylelint "**/*.{css,scss}"

Once you have the project correctly set up, run:

To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes:

bin/rails db:setup

Finally, each time you make changes to the project, run

In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description:

rspec

## Getting Started

- Check the Ruby version or if you have at all by running `ruby -v` if you get something like this `ruby 2.6.8p205 (2021-07-07 revision 67951)` you have Ruby installed.

- Clone the repository by running `git clone https://github.com/Pamphilemkp/car-reservation.git` in your CLI.

- Type `cd Exploration-Getaways-BACKEND`

- Type `code .`

- Run `bundle install`

#### NOTE  you need to have a master key in config directory. If none exists generate one. 

      - First delete `credentials.yml.enc`

      - Run EDITOR="code" bundle exec rails credentials:edit 

- Run `rails db:create db:migrate`

- Optionally you can run `rails db:seed` to populate it

- Run `rails server` to open the local server

- Open Browser `http://localhost:3000/`

### Usage

To run the project, execute the following command:

  rails server

--->

### Run tests

To run tests, run the following command:

sh

  bin/rails test test/models/article_test.rb

### API Documentation

Open Browser and visit `http://localhost:3000//api-docs/`

![Api Documentation Screenshot ](https://user-images.githubusercontent.com/98436409/211160780-b2cd9819-dc13-4fd8-beed-675c1f25ab96.png)

(back to top)


## 👥 :writing_hand: Authors 

:man_technologist: 👤 **Pamphile Mkp** :writing_hand:

- GitHub:   [@pamphilemkp](https://github.com/pamphilemkp)

- Twitter:  [@pamphilemkp](https://Twitter.com/PamphileMusonda)

- LinkedIn: [@pamphilemkp](https://www.linkedin.com/in/pamphile-musonda)

man_technologist: 👤 **Basit Ali** :writing_hand:

- GitHub: [@githubhandle](https://github.com/basitali111)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/basit-ali-jobs/)

- Twitter: [Twitter](https://twitter.com/BasitAl35031734)

(back to top)


:man_technologist: 👤 **Patrick Maina** :writing_hand:

- GitHub: [@PNdunguMaina](https://github.com/PNdunguMaina)

- LinkedIn: [Patrick Maina](https://www.linkedin.com/in/pndungumaina/)

- Twitter: [@ndunguwamaina_](https://twitter.com/ndunguwamaina_)

:man_technologist: 👤 **Mark otuya** :writing_hand:

- GitHub: [@githubhandle](https://github.com/markotuya0)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mark-otuya)

- Twitter: [Twitter](https://twitter.com/mark_anthonny)

:man_technologist: 👤 **Adebowale Adegboye Monsur** :writing_hand:

- GitHub: [@githubhandle](https://github.com/ademibowale)

- Twitter: [@twitterhandle](https://twitter.com/Ademibowale1)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/adebowale-adegboye-143568221/)

## 🔭 Future Features 

- [ ] **[Allow user to upload avatar]**

- [ ] **[Include "My Profile" section/page]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project or find it useful/interesting, please make sure you give ⭐️ a since this will make it easily accesible for you too!

(back to top)


## 🙏 Acknowledgments 


This work is licensed under a Creative Commons Attribution 4.0 International License.

(back to top)


## 📝 License 

This project is [MIT](./MIT.md) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/pamphilemkp/car-reservation

Awesome Lists containing this project

README
