Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/laundry_100_backend

Laundry_100_backend provides a RESTful interface for clients and servers, allowing them to interact with data stored.
https://github.com/stephenkati/laundry_100_backend

api api-documentation jwt postgresql rubyonrails

Last synced: about 1 month ago
JSON representation

Laundry_100_backend provides a RESTful interface for clients and servers, allowing them to interact with data stored.

Awesome Lists containing this project

README

        

# Laundry_100_backend

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [Laundry_100_backend]

**[Laundry_100_backend]** provides a RESTful interface for clients and servers, allowing them to interact with data stored.

# API

- The Api is consumed by [Laundry_100](https://github.com/stephenkati/Laundry_100)

## 🛠 Built With

### Tech Stack

Ruby on Rails

### Key Features

- **[]**
- **[]**
- **[]**

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

- Install Ruby
- Install Rails
- Install Rspec
- Install Postgresql

### Setup

Clone this repository to your desired folder:

```
git clone https://github.com/stephenkati/Laundry_100_backend.git
```

### Install

Install this project with:

```
cd Laundry_100_backend
bundle install
```

### Usage

To run the project, execute the following command:

```
rails s
```

### Run tests

To run tests, run the following command:

```
rubocop --color
```

```
rspec spec
```

### Deployment

- [N/A]

(back to top)

## 👥 Authors

👤 **Author1**
*[STEPHEN KATULI]*

- GitHub: [@githubhandle](https://github.com/stephenkati)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)

(back to top)

## 🔭 Future Features

- [ ] **[]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/stephenkati/Laundry_100_backend/issues).

(back to top)

## ⭐️ Show your support

If you like this project please show support by staring ⭐️.

(back to top)

## 🙏 Acknowledgments

* I would like to thank my Microverse team and my coding partners for their support and guidance.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)