https://github.com/omarmwarraich/chronicles
A blog for users to upload their posts, and to make comments on different posts besides liking different comments or posts.
https://github.com/omarmwarraich/chronicles
cancancan capybara-rspec devise postgresql rspec-rails ruby-on-rails
Last synced: 3 months ago
JSON representation
A blog for users to upload their posts, and to make comments on different posts besides liking different comments or posts.
- Host: GitHub
- URL: https://github.com/omarmwarraich/chronicles
- Owner: OmarMWarraich
- Created: 2023-01-17T08:36:05.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-11-09T03:56:01.000Z (11 months ago)
- Last Synced: 2025-06-12T18:06:08.502Z (4 months ago)
- Topics: cancancan, capybara-rspec, devise, postgresql, rspec-rails, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 465 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
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)
> Describe your project in 1 or 2 sentences.
**[Chronicles]** is a blog app where users can make accounts, create posts, get liked or commented upon by others.
> Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
> Describe between 1-3 key features of the application.
- Post, Comment, Like and Delete
- Authentication with Devise
- Authorization with Cancan
> Add a link to your deployed project.
- Coming Soon
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
Example command:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
git clone git@github.com:OmarMWarraich/chronicles.git
```
-
### Install
Install this project with:
Example command:
```sh
gem install
```
-
Do not forget to update the Ruby version in the GemFile and .ruby-version files of the Project if having conflict with your local version.
### Usage
To run the project, execute the following command:
Example command:
```sh
rails server
```
-
### Database Configuration
Update the username and password in config/database.yml as per your local configurations. Then run the following commands.
```sh
rails db:create
rails db:schema:load
```
### Run tests
To run tests, run the following command:
### Deployment
You can deploy this project using:
👤 **OmarMWarraich**
- GitHub: [@OmarMWarraich](https://github.com/OmarMWarraich)
- Twitter: [@omarwarraich1](https://twitter.com/omarwarraich1)
- LinkedIn: [LinkedIn](https://linkedin.com/in/o-va)
- Api Endpoints
- Upload Pics with Carrierwave
- NavBar having UserLogo w/ Gravtastic
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
> Give credit to everyone who inspired your codebase.
I would like to thank Team Microverse for giving me the oppurtunity to work in a professional remote software development programme.
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Does this app have a friendly UI?]**
- [Yes, this app has a very friendly UI.]
- **[Does this app have a database]**
- [This app uses PostgreSQL database. For runnng this app, PostgreSQL need to be installed on your system.]
This project is [MIT](./MIT) licensed.