Zainab-Alzubair/private-parking-backend

Private Parking

📗 Table of Contents

• 📗 Table of Contents
• [📖 Private Parking ](#-Private Parking-)
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • Front-end repository link
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
    • Check Linter
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Private Parking

This is a full-stack project with CURD operations. In which you can register yourself create a slots, book an parking slot , see all reservations.

🛠 Built With

Tech Stack

Client

• React

Server

• Ruby on Rails

Database

• Postgresql

Key Features

• User can register himself.
• Add a slot.
• Book a slot.

(back to top)

🚀 Live Demo

• API on Render

Front-end repository link

• React Front-end

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 - Laptop/Desktop.
 - Internet.
 - Ruby.
 - Rails.
 - PostgreSQL.
 - Vs Code.

Setup

Clone this repository to your desired folder:

 mkdir my-folder
 cd my-folder
 git clone git@github.com:Zainab-Alzubair/private-parking-backend.git
 cd private-parking-backend

• Remove config/master.key and config/credentials.yml.enc if they exist.
• Run in the terminal:

 EDITOR=code rails credentials:edit 

• This command will create a new master.key and credentials.yml.enc if they do not exist.

 bundle install

• Change username and password in config/database.yml file
• Run these commands to create and migrate database schema

 rails db:create
 rails db:migrate

Usage

To run the project, execute the following command:

rails server

Run tests

rails db:migrate RAILS_ENV=test
rspec ./spec/models/

Check Linter

rubocop

Deployment

• For deployement on render follow the instructions. Getting Started with Ruby on Rails on Render

(back to top)

👥 Authors

Zainab Al-Zubair

• GitHub: Zainab Al-Zubair
• LinkedIn: Zainab Al-Zubair

(back to top)

🔭 Future Features

• Add Full Authorization
• Developing more pages
• Enhance Design

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project you can fork it.

(back to top)

🙏 Acknowledgments

(back to top)

📝 License

This project is MIT licensed.

(back to top)