Grandeur-Backend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Grandeur Backend]

[Grandeur Backend] This is the backend API component of the Grandeur web application project, providing a Rails-based solution for managing and storing API data generated by the Grandeur web application.

🛠 Built With

Tech Stack

• Ruby
• Rails
• PostgreSQL

Key Features

• Provide server-side validations
• Provide Api endpoints

(back to top)

🚀 Live Demo

liveDemo

KanBan Board

KanBan Project link

Initial Kanban Board state

🔗 Frontend Link

The Grandeur-Frontend is built using React and Redux and is hosted on a separate repository. The front end handles the user interface and integrates with this backend API to retrieve and display data. To access our frontend repository, please click here.

(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 basic understanding of Ruby, Rails, and Git

• A Postgresql connection

  Usage

  1. Install Ruby
  2. Install Rails

  ruby >= 3.2.0
  rails >= 7.0
  postgres >- 15.3
  node

  3. Clone this repo

     git clone https://github.com/Elerqsousy/grandeur-backend.git

     development = grandeur_backend_development
     test        = grandeur_backend_test
     production  = grandeur_backend_production

     or you can use your own database and change the config/database.yml

  default: &default
    adapter: postgresql
    encoding: unicode
    pool: 5
    username: [your_username]
    password: [your_password]
    host: localhost

  development:
    <<: *default
    database: [your_database_for_development]

  test:
    <<: *default
    database: [your_database_for_test]

  production:
    <<: *default
    database: [your_database_for_production]

Install

Install this project with:

  cd grandeur-backend
  bundle install

To create your database and migrations in the application run the following commands

rails db:create
rails db:migrate
rails db:seed

it will install the required gemfile for running the project

To run the project, execute the following command:

  rails s

it will run the server on localhost:3000

To run the tests, execute the following command:

  rspec

(back to top)

👥 Authors

👤 Mahmoud Rizk

• GitHub: @Elerqsousy
• LinkedIn: Mahmoud Rizk

👤 Prosper Kessie

• GitHub: @kessie2862
• LinkedIn: Prosper Kessie

👤 Md Sazzad Hossain

• GitHub: @SAZZAD1Q2
• LinkedIn: Md Sazzad Hossain

(back to top)

🔭 Future Features

• [ ] [Proper User Authentication.]

(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, give it a ⭐.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and my coding partners. Special thanks (Gregoire Vella on Behance) for the design inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)