Loltolo-Lesapiti/rails-crud-api-backend

📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features
  • React Frontend
  • 🚀 Live Demo

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• ❓ FAQ
• 📝 License

📖 Task Manager

Task Manager is a simple application that allows users to add, edit, remove and search tasks. The application is build with ruby on rails and postgresql for backend which is contained in this repository and the react and redux for front end which is in a separate repository.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Rails

Database

• PostgreSQL

Key Features

• Tasks List endpoint
• Tasks Add endpoint
• Tasks Find using id param
• Tasks delete using id param
• Tasks show details using id param

API Documentation

• Here is the API documentation of the project Task Manager

(back to top)

React Frontend

• Here is the Frontend part of the project book appointment app

🚀 Live Demo

• Live Demo 🚀 😃

(back to top)

💻 Getting Started

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

Prerequisites

To run this project you need: Git and Ruby

 gem install rails

Install

Install this project with:

  bundle install

Create a Database (Mandatory)

rails db:create

If you have made a migration then run this command

rails db:migrate

rails db:seed

Usage

To run the project, execute the following command:

   rails s -p 3000 # # for serving the API on localhost:3000

Run tests

bundle exec rspec

(back to top)

👥 Author

👤 Petro Loltolo Lesapiti

• GitHub: @petrolesapiti
• LinkedIn: @petrolesapiti

(back to top)

🔭 Future Features

• User authentication
• User uthorization

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

(back to top)

❓ FAQ

• How I can install rails?

  • You can follow the official guide to install rails. If you have gem installed, you can run gem install rails to install rails.

• How I can run this project?

  • After cloning the repository, run bundle and then run rails s with option argument -p 3001. This will run the server on localhost:3001. You can change the port number if you want. Then you can use any API client to test the endpoints. For example, you can use Postman or Insomnia. You can also use the API Documentation to test the endpoints.

• How I can run tests?

  • After cloning the repository, run bundle and then run rspec to run the tests.

(back to top)

📝 License

This project is MIT licensed.

(back to top)