An open API service indexing awesome lists of open source software.

https://github.com/ibizugbe/car-valley-backend

Car valley is a full-stack web application that allows its users to book cars online, the frontend of the application was built with React js and Redux and we used Ruby on Rails in the backend to be able to generate at the end an API that the frontend uses
https://github.com/ibizugbe/car-valley-backend

bcrypt jwt-authentication postgresql ruby ruby-on-rails

Last synced: 6 months ago
JSON representation

Car valley is a full-stack web application that allows its users to book cars online, the frontend of the application was built with React js and Redux and we used Ruby on Rails in the backend to be able to generate at the end an API that the frontend uses

Awesome Lists containing this project

README

          

![car-valley](https://user-images.githubusercontent.com/71190715/207022607-a438ebe1-e0b7-4d76-9c72-3f323d10dac5.png)

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Final capstone\] ](#-final-capstone-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [1. Navigate to the location of the folder in your machine:](#1-navigate-to-the-location-of-the-folder-in-your-machine)
- [2. Install the gems:](#2-install-the-gems)
- [3. Set up the database with your credentials:](#3-set-up-the-database-with-your-credentials)
- [4. Create the databases:](#4-create-the-databases)
- [5. Migrate the databases:](#5-migrate-the-databases)
- [6. Seed the dummy data: (Necessary for Admin)](#6-seed-the-dummy-data-necessary-for-admin)
- [6. Install NPM packages:](#6-install-npm-packages)
- [7. Build and Watch Tailwindcss:](#7-build-and-watch-tailwindcss)
- [Usage](#usage)
- [7. Run the server:](#7-run-the-server)
- [Run tests](#run-tests)
- [Kanban Board ](#-kanban-)
- [👥 Authors ](#-authors-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# 📖 Car Valley App

## 🛠 Built With

### Tech Stack

Database

### Key Features

- **Rails API**

(back to top)

(back to top)

## 💻 Getting Started

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

Attached [here](https://github.com/Ibizugbe/car-valley-front-end) is the link to the frontend of the project, follow the instructions in the readme to get it up and running.

### Prerequisites

In order to run this project you need:

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/rex-9/WebArena.git
```

### Install

#### 1. Navigate to the location of the folder in your machine:

```
you@your-Pc-name:~$ cd
```

#### 2. Install the gems:

```
bundle install
```

#### 3. Set up the database with your credentials:

- setup the database environment in
```
config/database.yml
```

#### 4. Create the databases:

```
rails db:create
```

#### 5. Migrate the databases:

```
rails db:migrate
```

#### 6. Seed the dummy data: (Necessary for Admin)

```
rails db:seed
```

#### 6. Install NPM packages:

```
npm i
```

#### 7. Build and Watch Tailwindcss:

```
rails tailwindcss:watch
```

### Usage

To run the project, execute the following command:

#### 7. Run the server:

```
rails server
```
### Run tests

To run tests, run the following command:

Example commands:

```sh
bin/rails rspec spec
```

```sh
rake rswag
```

(back to top)

## Kanban Board

- Attached here is a [link](https://github.com/users/Ibizugbe/projects/2
) to the project kanban board
- This [link](https://github.com/microverseinc/curriculum-final-capstone/blob/main/projects/prepare_for_presentation.mdhttps://github.com/microverseinc/curriculum-final-capstone/blob/main/projects/prepare_for_presentation.md) contains the issue with the screenshot of the initial state of the kanban board.
- This team consists of a total number of four (4) people.

## 👥 Authors

👤 **Daniel Urimubenshi**

- Github: [@benshidanny11](https://github.com/benshidanny11/)
- LinkedIn: [@danielurimubenshi](https://www.linkedin.com/in/danielurimubenshi/)
- Twitter: [@DBenshi](https://twitter.com/DBenshi)

👤 **Rex**

- Github: [@rex-9](https://github.com/rex-9/)
- Medium: [@rex9](https://medium.com/rex9/)
- LinkedIn: [@rex9](https://www.linkedin.com/in/rex9/)
- Facebook: [@htetnaing0814](https://www.facebook.com/htetnaing0814)
- Angelist: [@rex9](https://angel.co/u/rex9)

👤 **Abraham Ibizugbe**

- GitHub: [@ibizugbe](https://github.com/ibizugbe)
- Twitter: [@abrahamibizugbe](https://twitter.com/abrahamibizugbe)
- LinkedIn: [Abraham Ibizugbe](https://linkedin.com/in/abrahamibizugbe)

👤 **Chrispaix Kaze**

- GitHub: [@Chrispaix Kaze](https://github.com/ChrispaixK)
- Twitter: [@Chrispaix Kaze](https://twitter.com/ChrispaixK)
- LinkedIn: [Chrispaix Kaze](https://www.linkedin.com/in/chrispaix-kaze-70445a175/)

(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, please kindly offer me opportunities for further contributions.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for giving the inspiration to build this project.

(back to top)

## ❓ FAQ

- **Can I build and use this project on Windows**

- Yes, you can. Check my commit history. If it's hard to understand, you can easily reach out to me.

(back to top)

## 📝 License

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

(back to top)