Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/larryivc/larrys-blog


https://github.com/larryivc/larrys-blog

Last synced: 4 days ago
JSON representation

Awesome Lists containing this project

README 

        





    

  
Larry's Blog





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

  - [Database](#database)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)



# 📖 [Larrys' Blog] 



**Larry's Blog** Will be a classic example of a blog website. I will 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.



## 🛠 Built With 



### Tech Stack 



  Language

  


  



### Key Features 



- [⭐️ Setup ]

- [⭐️ Controllers specs ]

- [⭐️ Creating data model ]

- [⭐️ Processing data in models]

- [⭐️ Validations, model specs]

- [⭐️ Adding routes and controllers]

- [⭐️ Adding controllers tests]

- [⭐️ Views]

- [⭐️ Forms]

- [⭐️ n+1 problems]

- [⭐️ Add devise]



(back to top)



## 💻 Getting Started 



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



### Setup



Clone this repository to your desired folder:



Example commands:



```sh

  cd my-folder



  git clone [email protected]:LarryIVC/larrys-blog.git

```



### Prerequisites



> You need the following tools be installed in your computer:



> - [Rails](https://guides.rubyonrails.org/)

> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)

> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)

> - IDE



(back to top)



### Install



Install this project with:



```sh

  cd larrys-blog



  bundle install

```



(back to top)



### 💾 Database



Create the databases and run migrations with:



```sh

  rails db:create



  rails db:migrate

```

(back to top)



### Usage



To run the project, execute the following command:



Example command:



```sh

  rails s 

```

  or



```sh

  rails server

```

(back to top)



### Run tests



To run tests, run the following command:



```sh

  rspec spec/

```



(back to top)



## 👥 Authors 



## 👤 **Larry Villegas**

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

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

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



## 👤 **Muneeb UR Rehman**



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

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

- LinkedIn: (https://www.linkedin.com/in/muneeb-rehman-01b6bb193/)



(back to top)



## 🔭 Future Features 



- [⭐️ Add authorization rules]

- [⭐️ Integration specs for views]

- [⭐️ Add API endpoints]

- [⭐️ API documentation]



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/LarryIVC/larrys-blog/issues).



(back to top)



## ⭐️ Show your support 



Help me with your criticisms and your suggestions, you will be blessed for such a noble gesture and give me a ⭐️ if you like this project. click [here ⭐️](https://github.com/LarryIVC/larrys-blog)



(back to top)



## 🙏 Acknowledgments 



I would like to thank *Microverse* for this opportunity.



(back to top)



## 📝 License 



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



(back to top)