📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ (OPTIONAL)
- 📝 License
📖 [ Blog app ]
[blog app ] A sample blogging platform that allows you to create, manage, and publish content on the internet in the form of a blog.
🛠 Built With
- Ruby on rails
Tech Stack
<
Client
Server
Database
Key Features
- User resource
- Comment resource
- Post resource
- Like resource
- Model validations
- Ability to add comments from the browser
- Ability to add posts from the browser
- Add likes to posts functionality
- Rspec tests
- Signup users
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
- A web browser e.g Chrome.
- Text Editor (VScode, Atom, Sublime text, etc)
- Basic knowledge of ruby
- Basic knowledge of RoR
In order to run this project you need:
- install ruby
- Install rails
- Install postgresQl
- Signup to Github
Setup
Clone this repository to your desired folder:
Command:
git clone git@github.com:Kasaija-Kenneth/blog-app.git
- cd
blog-app
Install
- After opening the files in Visual Studio Code, open the VS Code integrated terminal and run the following commands:
bundle init bundle install gem install rails
Usage
- Run the command in your terminal below to run the ruby program
run the
rails server
command in terminal runhttp://localhost:3000
in the browser url update config/database.yml with your local DataBase credentials
Run tests
- run
rspec
command to do spec_tests - Run the
rubocop -A
command in your terminal for linter checks and corrections
Deployment
You can deploy this project using:
👥 Authors
👤 Kasaija Kenneth
- GitHub: @Kasaija-Kenneth
- LinkedIn: LinkedIn
- Twitter: @kenn_ug
- Email: Send me a message:
👤 Recillah-Khamala
- GitHub: @Recillah-Khamala
- Twitter: @recillahk
- LinkedIn: LinkedIn
🔭 Future Features
-[ ] [ add authorization rules ]
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
Write a message to encourage readers to support your project
If you like this project...
🙏 Acknowledgments
Give credit to everyone who inspired your codebase.
I would like to thank...
📝 License
This project is MIT licensed.