simple-blog/README.md
2021-06-24 22:48:10 -04:00

89 lines
2.5 KiB
Markdown

<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/rzmk/simple-blog">
<img src="public/img/pencil.svg" alt="Pencil" width="80" height="80">
</a>
<h3 align="center">A Simple Blog</h3>
<div align="center">
<a href="https://webdev-course-blog-app.herokuapp.com/"><strong>View the blog here! »</strong></a>
<br />
</div>
</div>
<!-- TABLE OF CONTENTS -->
<details open="open">
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgements">Acknowledgements</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
<div align="center">
<img src="public/img/screenshot.png" alt="Screenshot">
</div>
A simple blog web application to learn full-stack web development.
Details
* Developing based on the [Web Developer Bootcamp](https://www.udemy.com/share/1013gG/) course.
* Using EJS for file organization and templating (components).
* Learning much about SQL CRUD operations, schema, SQL databases (SQLite), noSQL databases, and Mongoose ODM.
* Connecting to a MongoDB database storing post info, with a hidden method on the blog site for creating new posts.
### Built With
* [Bootstrap](https://getbootstrap.com)
* [Node.js](https://nodejs.org)
* [Express](https://expressjs.com)
* [Mongoose](https://mongoosejs.com/)
* [EJS](https://ejs.co/)
* [Heroku](https://www.heroku.com/)
* [MongoDB](https://www.mongodb.com/)
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<!-- CONTACT -->
## Contact
Mueez Khan - [@mueezkhan_](https://twitter.com/mueezkhan_)
Project Link: [https://github.com/rzmk/simple-blog](https://github.com/rzmk/simple-blog)
<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
* [Lodash](https://lodash.com/)
* [The Complete Web Development Bootcamp](https://www.udemy.com/share/1013gG/)
* [Best-README-Template](https://github.com/othneildrew/Best-README-Template)