Kaweesi-Matia/rails-react-backend

In this project, I will setup two apps for a FullStack Application and I will use this repo for the Backend part of the App using Ruby on Rails and Postgresql.

📗 Table of Contents

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

📖 Rails-app-for-API

Rails-app-for-API In this exercise, I will connect previous knowledge with new knowledge and use Webpack with jsbundling-rails gem.

🛠 Built With

Tech Stack

Client

• Ruby on rails
• React
• Redux

Database

• PostgreSQl

Key Features

• Making use of Ruby on Rails
• Making use of PostgreSQL

(back to top)

🚀 Live Demo

N/A

Link to React App

React App

(back to top)

💻 Getting Started

To start and run this project

bundle install

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

Prerequisites

• IDE to edit and run the code (We use Visual Studio Code 🔥).
• Git to versionning your work.
• PostgreSQL

Install & Setup

To setup and install this project, follow the below steps:

• Clone this project by the command:

$ git clone https://github.com/Kaweesi-Matia/rails-react-backend.git

• Then switch to the project folder by the bellow query:

$ cd Rails-app-for-API

• Install the required dependecies with bundle install
• Install npm dependencies with npm install
• Before running below commands update config/database.yml with your local DBcredentials. Then run: - rake db:create - rake db:migrate - rake db:seed
• With Ruby on Rails and PostgreSQL installed in your environment, you can run rails server to run the website.

Tests

• Run rake db:seed RAILS_ENV=test to seed the testing database
• Run rspec

Deployment

• I will deploy the project with render, after which you can access the live version of the project in the Live Demo section.

(back to top)

👥 Author

👤 Kaweesi Matia

• GitHub: @Kaweesi-Matia
• Twitter: @kaweesimatia
• LinkedIn: Kaweesi Matia

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Build the project schemas
• Use postgresql as my database instead of sql

(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 for these Design Guidelines
• Hat tip to anyone whose code was used 🤝
• Inspiration 🔥

(back to top)

📝 License

This project is MIT licensed.

(back to top)