📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Bare Foot Mechanic]

[Bare Foot Mechanic] is a Car repair appointment app built using React and Tailwind CSS on the frontend and Ruby on Rails on the backend.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

• [Create, delete, display from database]
• [Login with JWT]
• [Authorised with JWT]

(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:

• A Desktop or Laptop Computer running on with Windows, Mac OS or Linux operating system.
• VSCODE installed
• GitHub account
• Node.js installed
• Ruby installed (version 3.1.3 used)
• rails installed (version 7.0.4 used)
• Postgresql installed
• cmd or powershell to run the server

Clone repository to local machine for the back-end rails

Clone this repository link for the front-end react [REACT-FRONTEND]https://github.com/topeogunleye/appointment-front-end

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:svitalis123/Book-an-Appointment.git

Install

1. Install the dependencies:

  cd Book-an-Appointment
  bundle install

  (ensure rails version is the same and bundler is the same versions)

Usage

To run the project, execute the following command to start the backend server first

1. Create the database

rails db:create

2. Run the migrations

Run the migrations

3. Migrate the database

rails db:migrate

4. Seed the database

rails db:seed

5. Start the server on port 8000

  rails s -p 8000

After the backend is running, run the frontend

1. Clone the Front End Repo:

   git clone git@github.com:topeogunleye/appointment-front-end.git

2. Install the dependencies:

  cd appointement-front-end
  npm install

3. Start the server on port 3000

  npm start

Deployment

You can deploy this project using:

https://render.com

(back to top)

👥 Authors

👤 Temitope Ogunleye

• GitHub: @topeogunleye
• Twitter: @tope_leye
• LinkedIn: ogunleye

👤 David Amon-Cofie

• GitHub: @amon-cofie
• Twitter: @amon_cofie
• LinkedIn: David Amon-Cofie

👤 Shuhad Loofer

• GitHub: @Shuhad786
• LinkedIn: LinkedIn

👤 Vitalis Mutwiri

• GitHub: @svitalis123
• Twitter: @WilsonVitalis
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [ ] [Implement user authentication]
• [ ] [Update database with new user information]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Plese give a star on our repository as we worked long hours show casing our skills and would really appreciate your feedback thank you

(back to top)

🙏 Acknowledgments

The layout and color scheme was inspired by Murat Korkmaz please view his link below

Designed by:

• Murat Korkmaz https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign

(back to top)

❓ FAQ (OPTIONAL)

• [How did you determine the ERB diagram]

  • [We looked at what was needed and worked accordingly]

• [Was it hard doing this]

  • [Yes, it was however nothing worth struggling for comes easy]

(back to top)

📝 License

This project is MIT licensed.

(back to top)