Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/josphat205/blog-project


https://github.com/josphat205/blog-project

Last synced: 13 days ago
JSON representation

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

# Blog Project

This is ruby on rails project that has users, comment, likes and post

## Built With

- Ruby on rails

## Getting Started
To get a local copy up and running follow these simple example steps.

## Prerequisites
- Have a good knowledge on how to parse UI designs
- Have VSCode or other text editor installed. [Link to download VSCode](https://code.visualstudio.com/download)
- Install node package. [Link to download node](https://nodejs.org/en/download/)
- Have git installed.[Link to download git](https://git-scm.com/downloads)
- Create a github repository.

## Install
Install all project dependencies by running the command below
```
$ bundle install

$ bin/rails server

$ http://localhost:3000/
```

## Error check
```
$ rubocop .
```

-Follow the HTML-CSS linter confuguration to docs to setup linters [Link to Microverse linter docs](https://github.com/microverseinc/linters-config)

## Run tests

For tracking linters errors locally, you need to follow these steps:
- For tracking linter errors in HTML file run:

```Ruby
ruboc
```
```javascript
npx hint .
```

- For tracking linter errors in CSS file run:
```javascript
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```

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

- For tracking linter errors in Javascript and React file run:

```javascript
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```
```javascript
npx eslint .
```

## Deployment

- Use GitHub pages to deploy website
- For more information about publishing sources, see [About github pages](https://pages.github.com/)

## Authors

**Josphat Kiploman**

- GitHub: [@Josphat205](https://github.com/Josphat205)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/josphatloman/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you liked this project!

## Acknowledgments

- Microverse
- Coding Partners
- Code Reviewers

## 📝 License

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