Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/oguntayomicheal/ruby-on-rails-template


https://github.com/oguntayomicheal/ruby-on-rails-template

Last synced: 25 days ago
JSON representation

Awesome Lists containing this project

README

        

# rails template

# πŸ“— Table of Contents

- [Doctor\_appointment\_reservation\_back\_end](#doctor_appointment_reservation_back_end)
- [πŸ“— Table of Contents](#-table-of-contents)
- [πŸ“– \[Appointment\_booker\_back\_end\] ](#-appointment_booker_back_end-)
- [Link to the front-end repo](#link-to-the-front-end-repo)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐ Show your support ](#-show-your-support-)
- [πŸ™Acknowledgments ](#acknowledgments-)
- [πŸ“ License ](#-license-)

# πŸ“– [rails template]

**[rails template]** is a Ruby on Rails template repo to quickly get started on a project or take home assignments

##### [Link to the front-end repo](https://github.com/t)

## πŸ›  Built With

### Tech Stack

Ruby on Rails

### Key Features

- **[ ]**

## πŸ’» 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 Postgresql

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/
cd ....
```

### Install

Install this project with:

```sh
bundle install
```

```sh
gem install --no-document rubocop -v '>= 1.0, < 2.0'
```

### Usage

To run the project, execute the following command:

```sh
rails db:create
rails db:migrate
rails db:seed
rails server -p 4000
```

To view api documentation on the project, execute the following command when server is running:

```sh
http://localhost:4000/api-docs
```

### Run tests

To run tests, run the following command:

```sh
rspec spec
```

## πŸ‘₯ Authors

πŸ‘€ **Micheal Oguntayo**

- GitHub: [@oguntayomicheal](https://github.com/oguntayomicheal)
- Twitter: [@OguntayoMicheal](https://twitter.com/Oguns_micky)
- LinkedIn: [@OguntayoMicheal](https://www.linkedin.com/in/ogunsmicky/)

## πŸ”­ Future Features

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

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/s).

## ⭐ Show your support

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

## πŸ™Acknowledgments

-

## πŸ“ License

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

(back to top)