Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/naledi-dikgale/hello-rails

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/naledi-dikgale/hello-rails
Owner: Naledi-Dikgale
License: mit
Created: 2023-07-12T10:44:24.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-07-12T17:08:46.000Z (over 1 year ago)
Last Synced: 2023-07-12T17:42:35.118Z (over 1 year ago)
Language: Ruby
Size: 1000 Bytes
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Hello-Rails



# 📗 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)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 [Hello-Rails] 

**[Hello-Rails]** is an app built for the sake of practical learning of initialising the project with Ruby on Rails.

## 🛠 Built With 

### Tech Stack 

  Ruby on Rails

  


    https://rubyonrails.org/

  


### Key Features 

- **[Showcase Posts]**

- **[Add comments]**

- **[Add likes]**

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

### Setup

Clone this repository to your desired folder:

```sh

  cd Hello-Rails

  git clone https://github.com/Naledi-Dikgale/hello-rails.git

```

### Install

Install this project with:

```sh

  cd Hello-Rails

  bundle install

```

```sh

  gem install rspec

```

```sh

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

```

```sh

  npm install --save-dev [email protected] [email protected] [email protected] [email protected]

```

### Usage

To run the project, execute the following command:

```sh

  rails db:create

```

```sh

  rails db:migrate

```

```sh

  rake db:migrate

```

```sh

  rails server

```

### Run tests

To run tests, run the following command:

```sh

  rubocop --color

```

```sh

  npx stylelint "**/*.{css,scss}"

```

```sh

  rspec

```

### Deployment

  - [N/A]

(back to top)


## 👥 Authors 

👤 **Author1**

 *[NALEDI DIKGALE]*

 

- GitHub: [@githubhandle](https://github.com/Naledi-Dikgale)

- Twitter: [@twitterhandle](https://twitter.com/ChichiTheStar)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/naledi-dikgale-068423159/)

- Website: https://naledi-dikgale.github.io/mobile-portfolio/

(back to top)


## 🔭 Future Features 

- [ ] **[Add delete feature]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Naledi-Dikgale/hello-rails/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 give Microverse my sincerest gratitude for accommodating me in the Full-time Software Development program.

(back to top)


## 📝 License 

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

(back to top)