https://github.com/chaabaneanas/blog_app

https://github.com/chaabaneanas/blog_app

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/chaabaneanas/blog_app
• Owner: ChaabaneAnas
• Created: 2022-11-23T18:03:26.000Z (about 2 years ago)
• Default Branch: dev
• Last Pushed: 2022-12-14T09:08:08.000Z (about 2 years ago)
• Last Synced: 2024-12-06T03:39:31.837Z (about 1 month ago)
• Language: Ruby
• Size: 7.41 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  

  


  
Microverse README Template




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 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)

# 📖 [your_project_name] 

> Describe your project in 1 or 2 sentences.

**[Rails blog_app]** is a...

## 🛠 Built With 

### Tech Stack 

> A Blog app will be a classic example of a blog website. User will be able create a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

  Client

  


    
Ruby on Rails

  


  Server

  


    
Ruby on Rails

  


Database

  


    
PostgreSQL

  


(back to top)


## 🚀 Live Demo 

> coming soon.

- [Live Demo Link](https://yourdeployedapplicationlink.com)

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

rails instaled on your machine :

```sh

 gem install rails

```

and any kind of code editors(VScode for example ) :

```sh

sudo i code 

```

### Setup

Clone this repository to your desired folder:

Example commands:

```sh

  cd my-folder

  git clone [email protected]:myaccount/my-project.git

```

### Install

Install all the gems in the Gemfile:

```sh

  cd my-project

  bundle install 

```

--->

### Usage

To run the project, execute the following command:

```sh

  rails server

```

### Run tests

To run tests, run the following command:

```sh

  rspec ./spec/system

```

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Author1**

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

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

- LinkedIn: [LinkedIn](https://linkedin.com/in/AnasChabaane)

👤 **Author2**

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

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

- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)

(back to top)


(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

> don't forget to start the project if u like it

If you like this project...

(back to top)


## 🙏 Acknowledgments 

> Give credit to everyone who inspired your codebase.

I would like to thank Microverse for making all of this possible

(back to top)


(back to top)


## 📝 License 

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)